Swagger2 非全局、无需重复输入的Head参数&＃xff08;Token&＃xff09;配置
网络上关于Swagger2的教程多如牛毛&＃xff0c;作为关于Swagger加入全局head参数&＃xff08;如token&＃xff09;的文章也很多。例如:
Swagger2 添加HTTP head参数
Swagger2 添加HTTP head参数&＃xff0c;解决用户是token信息保留
但上述方案存在2个不足之处&＃xff1a;
- 需要在每个接口下单独输入参数
- 全局配置了参数&＃xff0c;如果某些接口&＃xff08;如login等&＃xff09;不需要参数&＃xff0c;则必须在改接口中通过annotation现实声明&＃xff0c;较为麻烦
综上&＃xff0c;选择优化方案如下&＃xff1a;
1.通过Swagger2的securitySchemes配置全局参数&＃xff1a;如下列代码所示&＃xff0c;securitySchemes的ApiKey中增加一个名为“Authorization”&＃xff0c;type为“header”的参数。
| 1 2 3 4 | private List securitySchemes() { return newArrayList( new ApiKey("Authorization", "Authorization", "header")); } |
2.在Swagger2的securityContexts中通过正则表达式&＃xff0c;设置需要使用参数的接口&＃xff08;或者说&＃xff0c;是去除掉不需要使用参数的接口&＃xff09;&＃xff0c;如下列代码所示&＃xff0c;通过PathSelectors.regex(“^(?!auth).*$”)&＃xff0c;所有包含”auth”的接口不需要使用securitySchemes。即不需要使用上文中设置的名为“Authorization”&＃xff0c;type为“header”的参数。
| 1 2 3 4 5 6 7 8 | private List securityContexts() { return newArrayList( SecurityContext.builder() .securityReferences(defaultAuth()) .forPaths(PathSelectors.regex("^(?!auth).*$")) .build() ); } |
设置完成后进入SwaggerUI&＃xff0c;右上角出现“Authorization”按钮&＃xff0c;点击即可输入我们配置的参数。
对于不需要输入参数的接口&＃xff08;上文所述的包含auth的接口&＃xff09;&＃xff0c;在未输入Authorization参数就可以访问。
其他接口则将返回401错误。点击右上角“Authorization”按钮&＃xff0c;输入配置的参数后即可访问。参数输入后全局有效&＃xff0c;无需每个接口单独输入。
至此&＃xff0c;完成Swagger2 非全局、无需重复输入的Head参数配置。
Swagger2的相关完整代码如下&＃xff08;工程基于Springboot&＃xff09;&＃xff1a;
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 | &＃64;Configuration &＃64;EnableSwagger2 public class Swagger { &＃64;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 securitySchemes() { return newArrayList( new ApiKey("Authorization", "Authorization", "header")); } private List securityContexts() { return newArrayList( SecurityContext.builder() .securityReferences(defaultAuth()) .forPaths(PathSelectors.regex("^(?!auth).*$")) .build() ); } List defaultAuth() { AuthorizationScope authorizationScope &＃61; new AuthorizationScope("global", "accessEverything"); AuthorizationScope[] authorizationScopes &＃61; new AuthorizationScope[1]; authorizationScopes[0] &＃61; authorizationScope; return newArrayList( new SecurityReference("Authorization", authorizationScopes)); } } |
坚持原创技术分享&＃xff0c;您的支持将鼓励我继续创作&＃xff01;
京公网安备 11010802041100号