界面風(fēng)格

使用過swagger-bootstrap-ui的朋友應(yīng)該都知道，它是基于左右菜單式的布局方式,這和目前大部分后臺管理系統(tǒng)有些類似，使用這種風(fēng)格的原因,我想應(yīng)該是更符合國人的操作習(xí)慣吧.

相比較swagger-ui的上下依次鋪開的結(jié)構(gòu)，我想這種方式更適合接口對接人員.

每個接口文檔主要通過文檔說明和在線調(diào)試兩個核心tab組件展開介紹,同時打開文檔說明則會以多tab的方式逐次展開文檔說明,來回切換查看不同接口文檔說明,方便快捷.

如下圖：

文檔說明：會根據(jù)Swagger的標(biāo)準(zhǔn)JSON文件,詳細(xì)的列出該接口的信息說明,主要包括：接口地址、接口類型、produces、consumes、接口參數(shù)字段說明、請求示例、響應(yīng)參數(shù)說明、響應(yīng)狀態(tài)碼、響應(yīng)示例

在線調(diào)試：開發(fā)者可以基于此文檔進(jìn)行接口的調(diào)試,ui會根據(jù)接口的信息自動列出請求參數(shù)、請求地址等信息,開發(fā)者只需要填寫相應(yīng)的字段值即可聯(lián)調(diào)測試