(转) 增加 header 参数,spring boot + swagger2(springfox)

Posted 不再蒙查查

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了(转) 增加 header 参数,spring boot + swagger2(springfox)相关的知识,希望对你有一定的参考价值。

 1 @Configuration
 2 @EnableSwagger2
 3 public class Swagger2 {
 4     @Bean
 5     public Docket createRestApi() {
 6         String auth = "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VybmFtZSI6Inh4IiwidGVybWluYWwiOiIxfDIiLCJleHAiOjE0OTIwNTIwMzIsIm5iZiI6MTQ5MTg3OTIzMn0.JAmqhJq9rIJOj7WCOm5t2bxcWRmRejADfwUWXmvlSEo";
 7         ParameterBuilder aParameterBuilder = new ParameterBuilder();
 8         aParameterBuilder.name("Authorization").defaultValue(auth).description("i").modelRef(new ModelRef("string")).parameterType("header").required(false).build();
 9 
10        // ParameterBuilder aParameterBuilder1 = new ParameterBuilder();
11        // aParameterBuilder1.name("token").description("").modelRef(new ModelRef("string")).parameterType("query").required(false).build();
12 
13         List<Parameter> aParameters = new ArrayList<Parameter>();
14         aParameters.add(aParameterBuilder.build());
15        // aParameters.add(aParameterBuilder1.build());
16 
17         return new Docket(DocumentationType.SWAGGER_2)
18                 .apiInfo(apiInfo())
19                 .useDefaultResponseMessages(false)
20                 .globalOperationParameters(aParameters)
21                 .select()
22                 .apis(RequestHandlerSelectors.basePackage("com.controller"))
23                 .paths(PathSelectors.any())
24                 .build();
25     }
26     private ApiInfo apiInfo() {
27         return new ApiInfoBuilder()
28                 .title("Spring Boot中使用Swagger2构建RESTful APIs")
29                 .description("更多Spring Boot相关文章请关注:https://spring.io")
30                 .version("1.0.1")
31                 .build();
32     }
33 }

此方法对所有的 rest api 添加 header , 如果想只在部分添加,login这样的不需要添加怎么办呢?暂时没找到办法

以上是关于(转) 增加 header 参数,spring boot + swagger2(springfox)的主要内容,如果未能解决你的问题,请参考以下文章

Spring + Springfox + Header 参数

nginx 在请求头request中增加header参数

Spring @JsonView 如何使用请求参数或标头

spring mvc获取header

求解惑,关于js跳转和header跳转的区别

Day610.SpringWebHeader解析常见错误 -Spring编程常见错误