如何生成RestFul Api文檔


Web API文檔工具列表
Swagger ——Swagger框架可以通過代碼生成漂亮的在線API,甚至可以提供運行示例。支持Scala、Java、Javascript、Ruby、PHP甚至 Actionscript 3。在線 Demo 。
I/O Docs ——I/O Docs是一個用於RESTful Web APIs的交互式文檔系統。使用 JSON 模型根據資源、方法和參數定義 APIs。I/O Docs 將生成 JavaScript 客戶端接口,可通過這些接口來調用系統。服務器端基於 Node.js 開發。在線Demo
apiary.io ——能夠快速啟動和運行文檔,包括GitHub集成和I/O驗證——更多建議可以前往Reddit查看上關於 Siyfion討論。
Docco ——Docco是一個快速而隨意、hundred-line-long、迭代程序風格的文檔生成器。它會以HTML的方式顯示評論和代碼。
Dexy ——非常靈活的一款文檔工具,支持任何語言編寫的API。
Doxygen ——Doxgen可以從一套歸檔源文件開始,生成HTML格式的在線類瀏覽器,或離線的LATEX、RTF參考手冊。對於未歸檔的源文件,也可以通過配置Doxygen來提取代碼結構。 更多建議可以前往Reddi上查看 gkumar007相關討論。
TurnAPI ——是一款付費的文檔API工具。里面包含了智能WIKI編輯器、基於標准的Markdown、文檔分支、還可以與Git、SVN、Mercurial同步、整潔的主題、友好的界面。
以上僅是作者在實踐中發現的一些很好的工具,如果你有更好的建議或工具推薦,歡迎與我們分享。

 

aglio工具—— danielgtaylor/aglio · GitHub 用 markdown 格式編寫文檔, 用 aglio生成 文檔頁面, 美觀, 簡單, 可定制
虛擬研討會:如何設計好的RESTful API?  http://www.infoq.com/cn/articles/how-to-design-a-good-restful-api/
 
 


免責聲明!

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



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