ApiBoot是一款基于SpringBoot1.x,2.x的接口服务集成基础框架, 内部提供了框架的封装集成、使用扩展、自动化完成配置,让接口开发者可以选着性完成开箱即用, 不再为搭建接口框架而犯愁,从而极大的提高开发效率。
ApiBoot
通过整合Swagger2
完成自动化接口文档生成,只需要一个简单的注解我们就可以实现文档的开启,而且文档上面的所有元素都可以自定义配置,通过下面的介绍来详细了解ApiBoot Swagger
的简易之处。
引入ApiBoot Swagger
在pom.xml
配置文件内通过添加如下依赖进行集成:
<!--ApiBoot Swagger-->
<dependency>
<groupId>org.minbox.framework</groupId>
<artifactId>api-boot-starter-swagger</artifactId>
</dependency>
@EnableApiBootSwagger
在添加依赖后需要通过@EnableApiBootSwagger
注解进行开启ApiBoot Swagger
相关的配置信息自动化构建,可以配置在XxxApplication入口类上,也可以是配置类,让SpringBoot
加载到即可。
相关配置
配置参数 | 参数介绍 | 默认值 |
---|---|---|
api.boot.swagger.enable |
是否启用 | true |
api.boot.swagger.title |
文档标题 | ApiBoot快速集成Swagger文档 |
api.boot.swagger.description |
文档描述 | ApiBoot通过自动化配置快速集成Swagger2文档,仅需一个注解、一个依赖即可。 |
api.boot.swagger.base-package |
文档扫描的package | XxxApplication同级以及子级package |
api.boot.swagger.version |
文档版本号 | api.boot.version |
api.boot.swagger.license |
文档版权 | ApiBoot |
api.boot.swagger.license-url |
文档版权地址 | |
api.boot.swagger.contact.name |
文档编写人名称 | 恒宇少年 |
api.boot.swagger.contact.website |
文档编写人主页 | |
api.boot.swagger.contact.email |
文档编写人邮箱地址 | |
api.boot.swagger.authorization.name |
整合Oauth2后授权名称 | ApiBoot Security Oauth 认证头信息 |
api.boot.swagger.authorization.key-name |
整合Oauth2后授权Header内的key-name | Authorization |
api.boot.swagger.authorization.auth-regex |
整合Oauth2后授权表达式 | ^.*$ |
以上是目前版本的所有配置参数,大多数都存在默认值,可自行修改。
整合ApiBoot Security Oauth
如果你的项目添加了Oauth2
资源保护,在Swagger
界面上访问接口时需要设置AccessToken
到Header
才可以完成接口的访问,ApiBoot Security Oauth
默认开放Swagger
所有相关路径,如果项目内并非通过ApiBoot Security Oauth2
来做安全认证以及资源保护,需要自行开放Swagger
相关路径。
携带Token访问Api
注意:通过
ApiBoot Security Oauth
所获取的AccessToken
类型都为Bearer
。