swagger-bootstrap-ui 1.9.4 發布,擴展支持動態欄位註釋

←手機掃碼閱讀     admin @ 2019-06-10 , reply:0

swagger-bootstrap-ui 1.9.4 發布了。swagger-bootstrap-ui是 Swagger 的增強UI 實現,使文檔更友好一點兒

文檔http://doc.xiaominfo.com

效果http://swagger-bootstrap-ui.xiaominfo.com/doc.html

Gitee:https://gitee.com/xiaoym/swagger-bootstrap-ui

GitHub:https://github.com/xiaoymin/swagger-bootstrap-ui

示例:https://gitee.com/xiaoym/swagger-bootstrap-ui-demo

特性&優化

1、最低需要JDK 1.8支持

2、單獨介面通過hash地址訪問,方便開發人員之間快速複製傳遞介面信息,能準確定位到介面

3、優化下載參數名稱問題,忽略filename大小寫敏感#IXA5C @Gitee

4、優化BasicFilter過濾器正則匹配頻率問題,decode函數調用替換為JDK 1.8版本中的java.util.Base64

5、tab操作項修改為點擊事件顯示,避免同調試按鈕衝突導致誤關選項卡#IXA5I @Gitee

6、增加調試介面響應類型為Xml、Html、Text的支持#IWP49 @Gitee

7、優化調試后header、raw、curl等選項卡高度太低的問題#IWLSU @Gitee

8、主頁簡介description欄位支持markdown格式#IVVRX @Gitee

9、針對枚舉類型的集合類型(List),在欄位描述中顯示枚舉可用列表值#100 @GitHub

10、重構原介面排序、tag排序規則,新增介面作者屬性,可寫每個介面的作者,方便開發者調試.參考文檔

11、針對Authorize授權的相關屬性,不同分組相同的請求參數只需授權一次即可則全局通用#IXHBL @Gitee

12、針對Map、JSONObject等動態類型可通過自定義註解@ApiOperationSupport或者@DynamicParameters來增加參數的欄位說明,解決不想寫實體類的煩惱,但是又無文檔的困擾.參考文檔

13、優化自定義文檔(markdown)界面效果,增加相關markdown語法樣式(引用editormd.css)

UI效果展示

項目地址

Maven坐標


<dependency>
   <groupId>com.github.xiaoymin</groupId>
   <artifactId>swagger-bootstrap-ui</artifactId>
   <version>1.9.4</version>
</dependency>

Star & Issue

感謝各位朋友的支持,前往https://gitee.com/xiaoym/swagger-bootstrap-ui點個Star吧~~ :)

源碼分析

距離上一個版本也有挺長時間了,這段時間主要是對springfox的源碼進行了一些研究和學習,並且記錄了一些博客,該版本(1.9.4)的一些功能也在看源碼的過程中對我有一些啟發,對於Swagger的規範也多了一些了解

對springfox源碼有興趣的朋友可以去我的博客查看,點擊前往





[admin ]

來源:OsChina
連結:https://www.oschina.net/news/107336/swagger-bootstrap-ui-1-9-4-released
swagger-bootstrap-ui 1.9.4 發布,擴展支持動態欄位註釋已經有124次圍觀

http://coctec.com/news/all/show-post-206833.html