1. 程式人生 > >API文件生成工具推薦

API文件生成工具推薦

隨著API的發展以及需求的日益增加,對API文字文件的需求與隨之而來。相信許多開發人員都遇到過編寫API文件方面的問題及煩惱。
你是否還通過手寫的方式來生成和編寫這些文件呢?那麼你就OUT啦!話說工欲善其事必先利其器,本文分享8款非常好的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相關討論。

——是一款付費的文件API工具。裡面包含了智慧WIKI編輯器、基於標準的Markdown、文件分支、還可以與Git、SVN、Mercurial同步、整潔的主題、友好的介面。

參考文章:https://segmentfault.com/a/1190000007704665
參考文章;https://www.zhihu.com/question/30434095

轉載:http://git.oschina.net/zhoujingjie/apiManager