資訊專欄INFORMATION COLUMN
摘要：相關(guān)配置配置參數(shù)參數(shù)介紹默認值是否啟用文檔標題快速集成文檔文檔描述通過自動化配置快速集成文檔，僅需一個注解一個依賴即可。注意通過所獲取的類型都為。
ApiBoot是一款基于SpringBoot1.x，2.x的接口服務集成基礎(chǔ)框架， 內(nèi)部提供了框架的封裝集成、使用擴展、自動化完成配置，讓接口開發(fā)者可以選著性完成開箱即用， 不再為搭建接口框架而犯愁，從而極大的提高開發(fā)效率。
ApiBoot通過整合Swagger2完成自動化接口文檔生成，只需要一個簡單的注解我們就可以實現(xiàn)文檔的開啟，而且文檔上面的所有元素都可以自定義配置，通過下面的介紹來詳細了解ApiBoot Swagger的簡易之處。
引入ApiBoot Swagger在pom.xml配置文件內(nèi)通過添加如下依賴進行集成：
org.minbox.framework api-boot-starter-swagger
注意：ApiBoot所提供的依賴都不需要添加版本號，但是需要添加版本依賴，具體查看ApiBoot版本依賴@EnableApiBootSwagger
在添加依賴后需要通過@EnableApiBootSwagger注解進行開啟ApiBoot Swagger相關(guān)的配置信息自動化構(gòu)建，可以配置在XxxApplication入口類上，也可以是配置類，讓SpringBoot加載到即可。
相關(guān)配置| 配置參數(shù) | 參數(shù)介紹 | 默認值 |
|---|---|---|
| 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 | 文檔版權(quán) | ApiBoot |
| api.boot.swagger.license-url | 文檔版權(quán)地址 | https://github.com/hengboy/ap... |
| 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后授權(quán)名稱 | ApiBoot Security Oauth 認證頭信息 |
| api.boot.swagger.authorization.key-name | 整合Oauth2后授權(quán)Header內(nèi)的key-name | Authorization |
| api.boot.swagger.authorization.auth-regex | 整合Oauth2后授權(quán)表達式 | ^.*$ |
以上是目前版本的所有配置參數(shù)，大多數(shù)都存在默認值，可自行修改。
整合ApiBoot Security Oauth如果你的項目添加了Oauth2資源保護，在Swagger界面上訪問接口時需要設(shè)置AccessToken到Header才可以完成接口的訪問，ApiBoot Security Oauth默認開放Swagger所有相關(guān)路徑，如果項目內(nèi)并非通過ApiBoot Security Oauth2來做安全認證以及資源保護，需要自行開放Swagger相關(guān)路徑。
整合ApiBoot Security Oauth很簡單，訪問ApiBoot Security Oauth 查看。
攜帶Token訪問Api啟動添加ApiBoot-Swagger依賴的項目后，訪問http://localhost:8080/swagger-ui.html頁面查看Swagger所生成的全部文檔，頁面右側(cè)可以看到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
文章版權(quán)歸作者所有，未經(jīng)允許請勿轉(zhuǎn)載,若此文章存在違規(guī)行為，您可以聯(lián)系管理員刪除。
轉(zhuǎn)載請注明本文地址：http://systransis.cn/yun/74054.html
摘要：如果全部使用默認值的情況話不需要做任何配置方式前提項目需要添加數(shù)據(jù)源依賴。獲取通過獲取啟用在使用格式化時非常簡單的，配置如下所示開啟轉(zhuǎn)換轉(zhuǎn)換時所需加密，默認為恒宇少年于起宇默認不啟用，簽名建議進行更換。 ApiBoot是一款基于SpringBoot1.x，2.x的接口服務集成基礎(chǔ)框架， 內(nèi)部提供了框架的封裝集成、使用擴展、自動化完成配置，讓接口開發(fā)者可以選著性完成開箱即...
摘要：的短信服務模塊是由阿里云的國際短信服務提供的，支持國內(nèi)和國際快速發(fā)送驗證碼短信通知和推廣短信。前提需要到阿里云控制臺申請開通短信服務。如果在阿里云控制臺定義的短信模板存在多個參數(shù)，可以通過方法來進行挨個添加，該方法返回值為本對象。 ApiBoot是一款基于SpringBoot1.x，2.x的接口服務集成基礎(chǔ)框架， 內(nèi)部提供了框架的封裝集成、使用擴展、自動化完成配置，讓接...
摘要：如下所示不配置默認使用自定義是的概念，用于自定義轉(zhuǎn)換實現(xiàn)，比如自定義格式化日期自動截取小數(shù)點等。下面提供一個的簡單示例，具體的使用請參考官方文檔。 ApiBoot是一款基于SpringBoot1.x，2.x的接口服務集成基礎(chǔ)框架， 內(nèi)部提供了框架的封裝集成、使用擴展、自動化完成配置，讓接口開發(fā)者可以選著性完成開箱即用， 不再為搭建接口框架而犯愁，從而極大...
摘要：添加快速集成的對象存儲服務，提供常用的文件操作方法，當然也提供自定義擴展，以致于滿足絕大數(shù)業(yè)務場景，并且通過擴展可以實現(xiàn)上傳文件進度條下載文件進度條存儲空間操作靜態(tài)網(wǎng)站托管訪問日志防盜鏈分片上傳追加上傳斷點續(xù)傳等等。 ApiBoot是一款基于SpringBoot1.x，2.x的接口服務集成基礎(chǔ)框架， 內(nèi)部提供了框架的封裝集成、使用擴展、自動化完成配置，讓接口開發(fā)者可以選...
摘要：注意如果你的方法返回對象只有一個資源對象需要映射，可以單獨配置使用注解。集合資源加載返回值為集合的示例類型作為返回值時，其中注意必須是對象類型。如果你有想要的使用方式，你就可以提交 ApiBoot Resource Load ApiBoot Resource Load是一款資源與業(yè)務完全分離的基礎(chǔ)框架，可以整合微服務(Feign、OpenFeign)進行負載均衡讀取固定類型、固定所屬業(yè)...
閱讀 2363·2021-11-08 13:13
閱讀 1306·2021-10-09 09:41
閱讀 1744·2021-09-02 15:40
閱讀 3240·2021-08-17 10:13
閱讀 2591·2019-08-29 16:33
閱讀 3191·2019-08-29 13:17
閱讀 3178·2019-08-29 11:00
閱讀 3331·2019-08-26 13:40
