隨著API的發(fā)展以及需求的日益增加,，對(duì)API文本文檔的需求與隨之而來(lái),。相信許多開發(fā)人員都遇到過(guò)編寫API文檔方面的問(wèn)題及煩惱。

你是否還通過(guò)手寫的方式來(lái)生成和編寫這些文檔呢,？那么你就OUT啦,！話說(shuō)工欲善其事必先利其器，本文分享8款非常好的API文檔生成工具給大家,。

Web API文檔工具列表

Swagger ——Swagger框架可以通過(guò)代碼生成漂亮的在線API，甚至可以提供運(yùn)行示例,。支持Scala,、Java、Javascript,、Ruby,、PHP甚至 Actionscript 3。在線 Demo ,。

I/O Docs ——I/O Docs是一個(gè)用于RESTful Web APIs的交互式文檔系統(tǒng),。使用 JSON 模型根據(jù)資源、方法和參數(shù)定義 APIs,。I/O Docs 將生成 JavaScript 客戶端接口,，可通過(guò)這些接口來(lái)調(diào)用系統(tǒng)。服務(wù)器端基于 Node.js 開發(fā),。在線Demo

——能夠快速啟動(dòng)和運(yùn)行文檔,，包括GitHub集成和I/O驗(yàn)證——更多建議可以前往Reddit查看上關(guān)于 Siyfion討論,。

Docco ——Docco是一個(gè)快速而隨意、hundred-line-long,、迭代程序風(fēng)格的文檔生成器,。它會(huì)以HTML的方式顯示評(píng)論和代碼。

Dexy ——非常靈活的一款文檔工具,，支持任何語(yǔ)言編寫的API,。

Doxygen ——Doxgen可以從一套歸檔源文件開始，生成HTML格式的在線類瀏覽器,，或離線的LATEX,、RTF參考手冊(cè)。對(duì)于未歸檔的源文件,，也可以通過(guò)配置Doxygen來(lái)提取代碼結(jié)構(gòu),。 更多建議可以前往Reddi上查看 gkumar007相關(guān)討論。

TurnAPI ——是一款付費(fèi)的文檔API工具,。里面包含了智能WIKI編輯器,、基于標(biāo)準(zhǔn)的Markdown、文檔分支,、還可以與Git,、SVN、Mercurial同步,、整潔的主題,、友好的界面。

以上僅是作者在實(shí)踐中發(fā)現(xiàn)的一些很好的工具,，如果你有更好的建議或工具推薦,，歡迎與我們分享。

來(lái)自：MATTSILVERMAN