轉(zhuǎn)自:https://my.oschina.net/u/811578/blog/657166
摘要: 隨著API的迅速發(fā)展侯勉，如何編寫出更加規(guī)范的API文檔說(shuō)明則顯的尤為重要政钟。你是否還通過(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開(kāi)發(fā)汉嗽。在線Demo
apiary.io——能夠快速啟動(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可以從一套歸檔源文件開(kāi)始撰筷，生成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)的一些很好的工具，如果你有更好的建議或工具推薦亲铡，歡迎與我們分享才写。
