Swagger2怎么整合OAuth2来在线调试接口?

知识改变命运,撸码使我快乐,2019年你的发迹线还好吗?

点赞再看,养成习惯

本篇文章对应源码码云(Gitee)仓库

https://gitee.com/minbox-projects/api-boot-chapter,您的Star是给我最大动力

前言

Swagger2作为侵入式文档中比较出色的一员,支持接口认证的在线调试肯定是不在话下的,当我们在调用OAuth2所保护的接口时,需要将有效的AccessToken作为请求HeaderAuthorization的值时,我们才拥有了访问权限,那么我们在使用Swagger在线调试时该设置AccessToken的值呢?

本文所需ApiBoot相关链接:

创建示例项目

在之前文章「使用Swagger2作为文档来描述你的接口信息」我们已经讲到了使用Swagger2来简单的描述接口,提供可视化在线的接口文档,我们本章的主要目的是来集成使用OAuth2实现在线调试接口,我们把之前章节测试的接口UserController复制到本篇文章中以便于测试,本章项目pom.xml依赖如下所示:

<dependencies>
  <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
  </dependency>
  <dependency>
    <groupId>org.minbox.framework</groupId>
    <artifactId>api-boot-starter-swagger</artifactId>
  </dependency>
  <dependency>
    <groupId>org.minbox.framework</groupId>
    <artifactId>api-boot-starter-security-oauth-jwt</artifactId>
  </dependency>
</dependencies>
<dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>org.minbox.framework</groupId>
      <artifactId>api-boot-dependencies</artifactId>
      <version>2.2.1.RELEASE</version>
      <type>pom</type>
      <scope>import</scope>
    </dependency>
  </dependencies>
</dependencyManagement>

如果你看过ApiBoot SecurityApiBoot OAuth你应该知道,通过application.yml文件简单的几行配置就可以集成Spring Security整合OAuth2,本章来使用内存方式配置用户列表以及客户端列表

ApiBoot Security & ApiBoot OAuth组件使用系列文章:https://blog.yuqiyu.com/apiboot-all-articles.html

如果你想深入的了解这个神奇的ApiBoot安全组件,可以通过依赖文章汇总链接学习。

启用ApiBoot Swagger

通过@EnableApiBootSwagger注解来启用ApiBoot Swagger相关功能,在XxxApplication入口类配置如下所示:

@SpringBootApplication
@EnableApiBootSwagger
public class ApibootSwaggerIntegratedOauthApplication {

    public static void main(String[] args) {
        SpringApplication.run(ApibootSwaggerIntegratedOauthApplication.class, args);
    }

}

配置ApiBoot Security

使用grant_type=password获取AccessToken时,需要我们传递用户的usernamepassword,使用默认的内存方式配置我们只需要在application.yml文件内添加如下配置:

api:
  boot:
    security:
      # 配置安全用户列表
      users:
        - username: yuqiyu
          password: 123123
      # 资源保护路径前缀,默认为/api/**
      auth-prefix: /**

配置ApiBoot OAuth

我们来添加OAuth2所需要的客户端列表配置信息,使用默认的内存方式配置客户端的client-idclient-secret,只需要修改application.yml文件内容如下所示:

api:
  boot:
    oauth:
      # 配置OAuth客户端列表
      clients:
        - clientId: minbox
          clientSecret: chapter

了解资源文件排除拦截

Swagger2可视化界面有很多静态资源组成,比如:js/css/images等,而集成Spring Security后这些资源需要排除权限拦截才可以访问到,如果是使用传统的方式整合Spring Security,需要使用WebSecurity来进行忽略路径才可以,而通过ApiBoot Security则是不用考虑这一点,在内部已经对Swagger的静态资源文件做出了排除。

运行测试

通过Application方式启动本章项目,Swagger可视化界面访问:http://localhost:8080/swagger-ui.html

获取AccessToken

通过CURL方式获取用户:yuqiyu的请求令牌,如下所示:

➜ ~ curl -X POST minbox:chapter@localhost:8080/oauth/token -d 'grant_type=password&username=yuqiyu&password=123123'
{"access_token":"304676a4-b9a6-4c4d-af40-e439b934aba8","token_type":"bearer","refresh_token":"ee2b5744-6947-4677-862e-fcf9517afca5","expires_in":7199,"scope":"api"}

Swagger在线调试

我们把获取的AccessToken与类型进行组合成:Bearer 304676a4-b9a6-4c4d-af40-e439b934aba8,将该令牌字符串配置到Swagger界面上,如下图所示:

输入后点击Authorize按钮即可。

敲黑板,划重点

Swagger的在线调试其实内部是模拟发送请求,将界面上输入的参数进行组合装配,发送到需要测试的接口路径,而上图设置AccessToken,也是一个临时保存,刷新页面就会丢失,发送请求时会自动追加到Request Header列表内。

代码示例

如果您喜欢本篇文章请为源码仓库点个Star,谢谢!!!
本篇文章示例源码可以通过以下途径获取,目录为apiboot-swagger-integrated-oauth

作者个人 博客
使用开源框架 ApiBoot 助你成为Api接口服务架构师

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,684评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,143评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,214评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,788评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,796评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,665评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,027评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,679评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 41,346评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,664评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,766评论 1 331
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,412评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,015评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,974评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,203评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,073评论 2 350
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,501评论 2 343

推荐阅读更多精彩内容