簡介

swagger-bootstrap-ui是springfox-swagger的增強UI實現(xiàn)，為Java開發(fā)者在使用Swagger的時候，能擁有一份簡潔、強大的接口文檔體驗

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

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

交流：

核心功能

該UI增強包主要包括兩大核心功能：文檔說明 和 在線調(diào)試

• 文檔說明：根據(jù)Swagger的規(guī)范說明，詳細(xì)列出接口文檔的說明，包括接口地址、類型、請求示例、請求參數(shù)、響應(yīng)示例、響應(yīng)參數(shù)、響應(yīng)碼等信息，使用swagger-bootstrap-ui能根據(jù)該文檔說明，對該接口的使用情況一目了然。

• 在線調(diào)試：提供在線接口聯(lián)調(diào)的強大功能，自動解析當(dāng)前接口參數(shù),同時包含表單驗證，調(diào)用參數(shù)可返回接口響應(yīng)內(nèi)容、headers、Curl請求命令實例、響應(yīng)時間、響應(yīng)狀態(tài)碼等信息，幫助開發(fā)者在線調(diào)試，而不必通過其他測試工具測試接口是否正確,簡介、強大。

UI增強

同時，swagger-bootstrap-ui在滿足以上功能的同時，還提供了文檔的增強功能，這些功能是官方swagger-ui所沒有的，每一個增強的功能都是貼合實際,考慮到開發(fā)者的實際開發(fā)需要,是比不可少的功能，主要包括：

• 個性化配置：通過個性化ui配置項，可自定義UI的相關(guān)顯示信息

• 離線文檔：根據(jù)標(biāo)準(zhǔn)規(guī)范，生成的在線markdown離線文檔，開發(fā)者可以進(jìn)行拷貝生成markdown接口文檔，通過其他第三方markdown轉(zhuǎn)換工具轉(zhuǎn)換成html或pdf，這樣也可以放棄swagger2markdown組件

• 接口排序：自1.8.5后，ui支持了接口排序功能，例如一個注冊功能主要包含了多個步驟,可以根據(jù)swagger-bootstrap-ui提供的接口排序規(guī)則實現(xiàn)接口的排序，step化接口操作，方便其他開發(fā)者進(jìn)行接口對接

UI特點

• 以markdown形式展示文檔,將文檔的請求地址、類型、請求參數(shù)、示例、響應(yīng)參數(shù)分層次依次展示,接口文檔一目了然,方便開發(fā)者對接
• 在線調(diào)試欄除了自動解析參數(shù)外,針對必填項著顏色區(qū)分,同時支持tab鍵快速輸入上下切換.調(diào)試時可自定義Content-Type請求頭類型
• 個性化配置項,支持接口地址、接口description屬性、UI增強等個性化配置功能
• 接口排序,支持分組及接口的排序功能
• 支持markdown文檔離線文檔導(dǎo)出,也可在線查看離線文檔
• 調(diào)試信息全局緩存,頁面刷新后依然存在,方便開發(fā)者調(diào)試
• 以更人性化的treetable組件展示Swagger Models功能
• 響應(yīng)內(nèi)容可全屏查看,針對響應(yīng)內(nèi)容很多的情況下，全屏查看，方便調(diào)試、復(fù)制
• 文檔以多tab方式可顯示多個接口文檔
• 請求參數(shù)欄請求類型、是否必填著顏色區(qū)分
• 主頁中粗略統(tǒng)計接口不同類型數(shù)量
• 支持接口在線搜索功能
• 左右菜單和內(nèi)容頁可自由拖動寬度
• 支持自定義全局參數(shù)功能，主頁包括header及query兩種類型
• i18n國際化支持,目前支持：中文簡體、中文繁體、英文
• JSR-303 annotations 注解的支持

UI效果圖