【推荐】2019 Java 开发者跳槽指南.pdf(吐血整理) >>>
知识改变命运,撸码使我快乐,2019年你的发迹线还好吗?<br/> 点赞再看,养成习惯<br/> 本篇文章对应源码码云(Gitee)仓库<br/> https://gitee.com/minbox-projects/api-boot-chapter,您的Star是给我最大动力
前言
Swagger2
作为侵入式文档中比较出色的一员,支持接口认证的在线调试肯定是不在话下的,当我们在调用OAuth2
所保护的接口时,需要将有效的AccessToken
作为请求Header
内Authorization
的值时,我们才拥有了访问权限,那么我们在使用Swagger
在线调试时该设置AccessToken
的值呢?
<!--more-->
本文所需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 Security
、ApiBoot 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
时,需要我们传递用户的username
、password
,使用默认的内存方式配置我们只需要在application.yml
文件内添加如下配置:
api:
boot:
security:
# 配置安全用户列表
users:
- username: yuqiyu
password: 123123
# 资源保护路径前缀,默认为/api/**
auth-prefix: /**
配置ApiBoot OAuth
我们来添加OAuth2
所需要的客户端列表配置信息,使用默认的内存方式配置客户端的client-id
、client-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
:
来源:oschina
链接:https://my.oschina.net/yuqiyu/blog/3146467