swagger添加header的token参数

master
zhangwei.c 2018-09-14 09:56:12 +08:00
parent be8a2deb15
commit 192070c801
2 changed files with 12 additions and 1 deletions

View File

@ -1,10 +1,14 @@
package com.boot.security.server.config;
import com.boot.security.server.filter.TokenFilter;
import com.google.common.collect.Lists;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.ParameterBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.schema.ModelRef;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
@ -23,9 +27,16 @@ public class SwaggerConfig {
@Bean
public Docket docket() {
ParameterBuilder builder = new ParameterBuilder();
builder.parameterType("header").name(TokenFilter.TOKEN_KEY)
.description("header参数")
.required(false)
.modelRef(new ModelRef("string")); // 在swagger里显示header
return new Docket(DocumentationType.SWAGGER_2).groupName("swagger接口文档")
.apiInfo(new ApiInfoBuilder().title("swagger接口文档")
.contact(new Contact("小威老师", "", "xiaoweijiagou@163.com")).version("1.0").build())
.globalOperationParameters(Lists.newArrayList(builder.build()))
.select().paths(PathSelectors.any()).build();
}
}

View File

@ -28,7 +28,7 @@ import com.boot.security.server.service.TokenService;
@Component
public class TokenFilter extends OncePerRequestFilter {
private static final String TOKEN_KEY = "token";
public static final String TOKEN_KEY = "token";
@Autowired
private TokenService tokenService;