簡(jiǎn)介

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

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

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

交流：

核心功能

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

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

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

UI增強(qiáng)

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

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

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

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

UI特點(diǎn)

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

UI效果圖