如何生成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同步、整潔的主題、友好的界面。
以上僅是做者在實踐中發現的一些很好的工具，若是你有更好的建議或工具推薦，歡迎與咱們分享。

 

文檔生成工具—— apiDoc - Inline Documentation for RESTful web APIs

aglio工具—— danielgtaylor/aglio · GitHub 用 markdown 格式編寫文檔, 用 aglio生成 文檔頁面, 美觀, 簡單, 可定製

虛擬研討會：如何設計好的RESTful API？  http://www.infoq.com/cn/articles/how-to-design-a-good-restful-api/