Swagger-UI 基於REST的API測試/文檔類插件

如今多數的項目開發中，網站和移動端都須要進行數據交互和對接，這少不了使用REST編寫API接口這種場景。例如我目前的工做，移動端交由了另外一團隊開發，不一樣開發小組之間就須要以規範和文檔做爲標準和協做基礎。良好的文檔能夠讓開發事半功倍，而做爲又懶又要效率又能交代的碼農，固然最但願一切自動化，或用小聰明來找到最適合的工具。

Swagger-UI簡單而一目瞭然。它可以純碎的基於html+javascript實現，只要稍微整合一下便能成爲方便的API在線測試工具。項目的設計架構中一直提倡使用TDD（測試驅動）原則來開發，swagger-ui在這方面更是能提供很大幫助。

Swagger-UI更傾向於在線測試接口和數據，但其核心是一個javascript插件，只要稍做修改，便能按需求定製出不一樣格式的說明文檔，在github上更是基於它集成到各類語言環境，分支衆多。

其官方提供了一個離線版本，其使用方法十分簡單：直接在js格式的資源文件中錄入REST API的json信息，便能容易地生成不一樣模塊下的API列表，每一個API接口描述和參數、請求方法都能在每一個json數組中定製。下面是目前項目中使用到的部分預覽圖：

Swagger-UI 的官方地址：

http://swagger.wordnik.com

Github上的項目地址：

https://github.com/wordnik/swagger-ui

官方提供的demo地址

http://petstore.swagger.wordnik.com/

------------------------------------------------------------------

2012年10月19日更新：

下面是本身目前修改後的demo：

1. 添加了window.swaggerUi 中的幾個參數（說明文件），更方便資源文件的編寫

2. 修復了測試時post方法的bug

3. 界面顯示中文

4. 根據每一個接口的更新狀況，定製了一些修訂說明

下載地址 ：http://amuropikin.iteye.com/admin/blogs/1701537

------------------------------------------------------------------

2012年10月24日更新

基於和合做團隊的交流和改進建議，修改和增長了如下功能

1. 顯示每一個api的修改人、更新時間、接口更新狀態（擬定、完成和重大修改）

2. 自動整理api的歷史修改記錄

3. 增長了返回結果的json示例

4. 增長告終果字段的說明表格

demo在近期優化後放出：）