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


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM