spring-boot-starter-swagger迎新夥伴支持,加速更新進度
從該starter創建至今收到了不少使用反饋,同時也有不錯的童鞋申請加入一起維護。本篇先歡迎小火童鞋的加入及貢獻,接下來具體說說本次的更新內容。
本次更新主要新增了下面兩項內容:
新增API文檔的host配置
新增對JSR-303註解的支持
同時我們也更新了使用文檔,其中涵蓋了1.3.0.RELEASE所有支持的配置功能。
更多關於starter的介紹可見如下內容。
簡介
該項目主要利用Spring Boot的自動化配置特性來實現快速的將swagger2引入spring boot應用來生成API文檔,簡化原生使用swagger2的整合代碼。
源碼地址
GitHub:https://github.com/dyc87112/spring-boot-starter-swagger
碼云:https://gitee.com/didispace/spring-boot-starter-swagger
使用樣例:https://github.com/dyc87112/swagger-starter-demo
我的博客:http://blog.didispace.com
我們社區:http://spring4all.com
小工具一枚,歡迎使用和Star支持,如使用過程中碰到問題,可以提出Issue,我會儘力完善該Starter
版本基礎
Spring Boot:1.5.x
Swagger:2.7.x
如何使用
在該項目的幫助下,我們的Spring Boot可以輕鬆的引入swagger2,主需要做下面兩個步驟:
在 中引入依賴:
在應用主類中增加 註解
默認情況下就能產生所有當前Spring MVC載入的請求映射文檔。
參數配置
更細緻的配置內容參考如下:
配置示例
配置說明默認配置
host屬性從1.3.0.RELEASE開始支持
Path規則說明
和 使用ANT規則配置。
我們可以使用 來指定所有需要生成文檔的請求路徑基礎規則,然後再利用 來剔除部分我們不需要的。
比如,通常我們可以這樣設置:
上面的設置將解析所有除了 開始以及spring boot自帶 請求路徑。
其中, 可以配合 設置的spring boot actuator的context-path來排除所有監控端點。
分組配置
當我們一個項目的API非常多的時候,我們希望對API文檔實現分組。從1.2.0.RELEASE開始,將支持分組配置功能。
具體配置內容如下:
說明: 為swagger文檔的分組名稱,同一個項目中可以配置多個分組,用來劃分不同的API文檔。
分組配置示例
說明:默認配置與分組配置可以一起使用。在分組配置中沒有配置的內容將使用默認配置替代,所以默認配置可以作為分組配置公共部分屬性的配置。
JSR-303校驗註解支持
支持對JSR-303校驗註解的展示,如下圖所示:
目前共支持以下幾個註解:
貢獻者
程序猿DD-翟永超
小火
![](https://pic.pimg.tw/zzuyanan/1488615166-1259157397.png)
![](https://pic.pimg.tw/zzuyanan/1482887990-2595557020.jpg)
TAG:程序猿DD的技術分享 |
※新聞-Adobe Photoshop 開始正式支持 Surface Dial
※Xbox One未來更新有望支持Alexa和Google Assistant
※深度學習戰爭:Facebook 支持的 PyTorch與Google的TensorFlow
※谷歌Advanced Protection Program現支持iOS應用
※你支持新興的生物能源行業嗎?Australian made Bio-fuel Anyone?
※Google Daydream SDK更新支持多控制器
※一加手機5/5T的Android Oreo更原生了,已支持Project Treble
※谷歌Advanced Protection Program現支持iOS官方應用
※Google Chrome和Mozilla Firefox將支持全新無密碼登錄規範
※3DHoloGroup推出AR女友,支持HoloLens、Meta 2、Magic Leap
※Corona Corporation改由Rimini Street提供Oracle EBS支持服務
※Oracle,Red Hat等大廠近期密集發布,加強支持Kubernetes
※深入 Spring Boot :實現對 Fat Jar jsp 的支持
※3DHoloGroup推出AR女友 支持HoloLens、Meta 2、Magic Leap
※Twitter App將不再支持Windows平台
※微軟用SharePoint Spaces為SharePoint添加混合現實支持
※Windows 10 和 Edge 全面支持PWA,PWA可提交至Microsoft Store
※獨立遊戲強化!GameMaker Studio 2將支持Switch
※Rimini Street為Solar Frontier提供一流的SAP支持服務
※修補DoublePulsar支持攻擊Windows Embedded系統