Swagger2 非全局、无需重复输入的Head参数(Token)配置

转载 2018年04月17日 14:33:33

网络上关于Swagger2的教程多如牛毛,作为关于Swagger加入全局head参数(如token)的文章也很多。例如:

Swagger2 添加HTTP head参数

Swagger2 添加HTTP head参数,解决用户是token信息保留

但上述方案存在2个不足之处:

  1. 需要在每个接口下单独输入参数
  2. 全局配置了参数,如果某些接口(如login等)不需要参数,则必须在改接口中通过annotation现实声明,较为麻烦

综上,选择优化方案如下:

1.通过Swagger2的securitySchemes配置全局参数:如下列代码所示,securitySchemes的ApiKey中增加一个名为“Authorization”,type为“header”的参数。

1
2
3
4
private List<ApiKey> securitySchemes() {
return newArrayList(
new ApiKey("Authorization", "Authorization", "header"));
}

2.在Swagger2的securityContexts中通过正则表达式,设置需要使用参数的接口(或者说,是去除掉不需要使用参数的接口),如下列代码所示,通过PathSelectors.regex(“^(?!auth).*$”),所有包含”auth”的接口不需要使用securitySchemes。即不需要使用上文中设置的名为“Authorization”,type为“header”的参数。

1
2
3
4
5
6
7
8
private List<SecurityContext> securityContexts() {
return newArrayList(
SecurityContext.builder()
.securityReferences(defaultAuth())
.forPaths(PathSelectors.regex("^(?!auth).*$"))
.build()
);
}

设置完成后进入SwaggerUI,右上角出现“Authorization”按钮,点击即可输入我们配置的参数。
对于不需要输入参数的接口(上文所述的包含auth的接口),在未输入Authorization参数就可以访问。
其他接口则将返回401错误。点击右上角“Authorization”按钮,输入配置的参数后即可访问。参数输入后全局有效,无需每个接口单独输入。
image.png
至此,完成Swagger2 非全局、无需重复输入的Head参数配置。
Swagger2的相关完整代码如下(工程基于Springboot):

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
@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));
}
}

转载自:

http://fish119.site/2018/01/04/Swagger2-%E9%9D%9E%E5%85%A8%E5%B1%80Header%E5%8F%82%E6%95%B0%EF%BC%88Token%EF%BC%89%E9%85%8D%E7%BD%AE/

Swagger2 添加HTTP head参数

大家使用swagger往往会和JWT一起使用,而一般使用jwt会将token放在head里,这样我们在使用swagger测试的时候并不方便,因为跨域问题它默认不能自定义head参数。然后自己去网上找,...
  • u014044812
  • u014044812
  • 2017-05-09 15:19:51
  • 11316

Swagger2在header中添加token(java)

@Bean public Docket apiDocument() { return new Docket(DocumentationType.SWAGGER_2) ...
  • wanzhix
  • wanzhix
  • 2017-07-24 14:03:16
  • 2872

Swagger2 (4)针对于相同url headers 参数不同映射不同的方法问题(已解决)

Swagger2 (4)针对于相同url headers 参数不同映射不同的方法问题(已解决)。
  • sai739295732
  • sai739295732
  • 2017-10-27 16:50:25
  • 636

java swagger ui 添加header请求头参数

我用到的swagger 主要有三款产品,swagger editor,swagger ui 和swagger codegen。  swagger editor:主要是一个本地客户端,用来自己添加ap...
  • uncle_david
  • uncle_david
  • 2018-02-07 19:31:05
  • 590

ASP.NET Core 在 Swagger UI 中显示自定义的 Header Token

Swagger 是个好东西,对于前后端分离的网站来说,不仅是提高前后端开发人员沟通效率的利器,也大大方便了后端人员测试 API。本文介绍如何在 Swagger UI 中显示自定义的 Header To...
  • sD7O95O
  • sD7O95O
  • 2016-12-20 07:27:15
  • 464

jquery的ajax全局配置

jquery的ajax全局配置var token = localStorage.getItem("token");$.ajaxSetup({ dataType: "json", cac...
  • xiaojin21cen
  • xiaojin21cen
  • 2017-11-23 10:33:43
  • 391

Swagger2+SpringMVC配置详解

swagger是一个前后端api统一文档和测试框架,注意,不光是一个api文档,还可以测试怎么使用呢 这里慢慢道来,我们一般用的都是maven工程,所以这里直接上maven依赖: > 1.5.8 2....
  • junlei0426
  • junlei0426
  • 2017-02-13 17:25:13
  • 6934

SpringMVC注解配置Swagger2步骤及相关知识点

Swagger2的功能不多说了,百度一下随处可见,配置步骤也十分简单,但一些点百度到的很多都不太详细,个人进行了一些补充 1、pom.xml添加swagger2依赖(个人一般直接到http://se...
  • z28126308
  • z28126308
  • 2017-05-03 18:56:34
  • 3430

SpringMVC RESTful风格CURD并集成Swagger2

RESTful风格的URL,每个网址代表一种资源,其显著的特征就是对于资源的具体操作类型,由HTTP动词表示。SpringMVC 本身是支持 PUT,DELETE 等 HTTP 请求方式的,但由于某些...
  • zxc123e
  • zxc123e
  • 2017-07-28 17:13:32
  • 1110

axios全局请求参数设置,请求及返回拦截器

应用场景: 1,每个请求都带上的参数,比如token,时间戳等。 2,对返回的状态进行判断,比如token是否过期 代码如下: axios.interceptors.request.use( ...
  • panyox
  • panyox
  • 2017-06-27 15:50:09
  • 11999
收藏助手
不良信息举报
您举报文章:Swagger2 非全局、无需重复输入的Head参数(Token)配置
举报原因:
原因补充:

(最多只允许输入30个字)