问题描述
现在很多开发都开始使用swagger来作为对接接口和测试接口的工具，而且swagger确实真的很好用，但是在很多框架中都需要传令牌来验证登录情况，下面记录了我整理的两种方式，这里以token为例（其他的其实也是一样的）。
第一种方法 设置全局token
效果图
代码
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
//加了ApiOperation注解的类，才生成接口文档
.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
//包下的类，才生成接口文档
//.apis(RequestHandlerSelectors.basePackage("io.sysssc.controller"))
.paths(PathSelectors.any())
.build()
.securitySchemes(security()); //主要关注点--统一填写一次token
}
private List<ApiKey> security() {
return newArrayList(
new ApiKey("token", "token", "header")
);
}
说明
上面两段代码主要都是在swagger的配置类SwaggerConfig（或者Swagger2Config）中，createRestApi()方法是原本配置类中就有的，主要就关注最后一个引用的方法即可。security()方法中token是可以自己定义的。
第二种方法 接口单独传token
效果图
代码
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
//加了ApiOperation注解的类，才生成接口文档
.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
//包下的类，才生成接口文档
//.apis(RequestHandlerSelectors.basePackage("io.sysssc.controller"))
.paths(PathSelectors.any())
.build()
.globalOperationParameters(globalOperation()); // 主要关注点----每个接口调用都填写token
}
private List<Parameter> globalOperation(){
//添加head参数配置start
ParameterBuilder tokenPar = new ParameterBuilder();
List<Parameter> pars = new ArrayList<>();
//第一个token为传参的key，第二个token为swagger页面显示的值
tokenPar.name("token").description("token").modelRef(new ModelRef("string")).parameterType("header").required(false).build();
pars.add(tokenPar.build());
return pars;
}
至此，两种配置方式完成！！！
