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