问题由来:
最近愈发感觉写接口文档太麻烦了,就研究了一下swagger,springboot用起来确实不要太方便,什么多余的操作都不需要有就可以把链接甩给前端了。
但是通常我们的系统都是带有身份认证的,无非几种方式,cookie,session,token,前两种可以算为一类,这个倒是比较好解决,下个chrome插件,可以很轻松的把一个页面下的cookie复制到我们的swagger-ui界面下来,但是要注意修改域。
比如 EditThisCookie 插件。
但是token怎么办呢?必须要在每一个请求的header都加上token。
解决方案:
从其他的博客上找到的
转自:https://www.jianshu.com/p/6e5ee9dd5a61
//通过Swagger2的securitySchemes配置全局参数:如下列代码所示,securitySchemes的ApiKey中增加一个名为“Authorization”,type为“header”的参数。
private List<ApiKey> securitySchemes() {
return newArrayList(
new ApiKey("Authorization", "Authorization", "header"));
}
//在Swagger2的securityContexts中通过正则表达式,设置需要使用参数的接口(或者说,是去除掉不需要使用参数的接口),如下列代码所示,通过PathSelectors.regex("^(?!auth).*$"),所有包含"auth"的接口不需要使用securitySchemes。即不需要使用上文中设置的名为“Authorization”,type为“header”的参数。
private List<SecurityContext> securityContexts() {
return newArrayList(
SecurityContext.builder()
.securityReferences(defaultAuth())
.forPaths(PathSelectors.regex("^(?!auth).*$"))
.build()
);
}
//设置完成后进入SwaggerUI,右上角出现“Authorization”按钮,点击即可输入我们配置的参数。
//对于不需要输入参数的接口(上文所述的包含auth的接口),在未输入Authorization参数就可以访问。
//其他接口则将返回401错误。点击右上角“Authorization”按钮,输入配置的参数后即可访问。参数输入后全局有效,无需每个接口单独输入。
//至此,完成Swagger2 非全局、无需重复输入的Head参数配置。
//Swagger2的相关完整代码如下(工程基于Springboot):
@Configuration
@EnableSwagger2
public class Swagger {
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2).
useDefaultResponseMessages(false)
.select()
.apis(RequestHandlerSelectors.any())
.paths(PathSelectors.regex("^(?!auth).*$"))
.build()
.securitySchemes(securitySchemes())
.securityContexts(securityContexts())
;
}
private List<ApiKey> securitySchemes() {
return newArrayList(
new ApiKey("Authorization", "Authorization", "header"));
}
private List<SecurityContext> securityContexts() {
return newArrayList(
SecurityContext.builder()
.securityReferences(defaultAuth())
.forPaths(PathSelectors.regex("^(?!auth).*$"))
.build()
);
}
List<SecurityReference> defaultAuth() {
AuthorizationScope authorizationScope = new AuthorizationScope("global", "accessEverything");
AuthorizationScope[] authorizationScopes = new AuthorizationScope[1];
authorizationScopes[0] = authorizationScope;
return newArrayList(
new SecurityReference("Authorization", authorizationScopes));
}
}
效果如下
“`