ApiBoot - ApiBoot Swagger 使用文檔

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>           

注意：

ApiBoot

所提供的依賴都不需要添加版本号，但是需要添加版本依賴，具體檢視 ApiBoot版本依賴

@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	文檔版權位址	https://github.com/hengboy/api-boot
api.boot.swagger.contact.name	文檔編寫人名稱	恒宇少年
api.boot.swagger.contact.website	文檔編寫人首頁	http://blog.yuqiyu.com
api.boot.swagger.contact.email	文檔編寫人郵箱位址	[email protected]
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

相關路徑。

整合

ApiBoot Security Oauth

很簡單，通路

ApiBoot Security Oauth

檢視。

攜帶Token通路Api

啟動添加

ApiBoot-Swagger

依賴的項目後，通路

http://localhost:8080/swagger-ui.html

頁面檢視

Swagger

所生成的全部文檔，頁面右側可以看到Authorize，點選後打開配置

AccessToken

的界面，配置的

AccessToken

必須攜帶類型，如：

Bearer 0798e1c7-64f4-4a2f-aad1-8c616c5aa85b

。

注意：通過

ApiBoot Security Oauth

所擷取的

AccessToken

類型都為

Bearer

本章源碼位址：

https://github.com/hengboy/api-boot/tree/master/api-boot-samples/api-boot-sample-swagger