Springboot agregar encabezado de solicitud (swagger)


Springboot agregar encabezado de solicitud (swagger)

 

Aplicación: Al usar swagger ui para probar la interfaz, puede agregar encabezados para pruebas relacionadas

 

*****************************

Ejemplos

 

*********************

capa de configuración

 

Swagger2Config

@Configuration
@EnableSwagger2
public class Swagger2Config {

    @Bean
    public Docket initDocket(){
        List<Parameter> params=new ArrayList<>();
        Parameter header=new ParameterBuilder().name("header_name").description("请求头")
                .modelRef(new ModelRef("string")).parameterType("header")
                .required(false).defaultValue("gtlx").build();
        params.add(header);

        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(initApiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.demo.controller"))
                .paths(PathSelectors.any())
                .build()
                .globalOperationParameters(params);
    }

    private ApiInfo initApiInfo(){
        return new ApiInfoBuilder()
                .title("构建 swagger2")
                .description("接口测试")
                .termsOfServiceUrl("http://www.baidu.com")
                .version("v1.0")
                .build();
    }
}

 

*********************

capa de controlador

 

HelloController

@RestController
public class HelloController {

    @RequestMapping("/hello")
    public String hello(@RequestHeader("header_name") String value){
        System.out.println(value);

        return "hello world "+value;
    }
}

 

 

***********************

Prueba de uso

 

localhost: 8080 / swagger-ui.html

      

      

 

      

      

Nota: El valor del encabezado no puede ser chino; de lo contrario, se informará un error Error al ejecutar 'buscar' en 'Ventana': el valor no es un ByteString válido.

 

 

387 artículos originales publicados · Me gusta 98 · Visitas 30,000+

Supongo que te gusta

Origin blog.csdn.net/weixin_43931625/article/details/105003926
Recomendado
Clasificación