REST API文檔生成

Question

是否有庫提供編寫REST API文檔的標記？我見過幾個企業使用類似文件模式，例如：

http://api.teamlab.com/2.0/

http://www.fullcontact.com/docs/?category=person

我，如果他們使用相同的庫或服務不知道。本質上，庫應該基於標記文本生成API導航，搜索和顯示的頁面（很像YARD的Ruby文檔）。

這是我迄今發現：

• rapi_doc gem。這裏是討論使用情況的article。

Answer 1

你一定要看看Swagger。

它是開放源代碼，由數百個API使用，也被3scale在其API管理解決方案中使用，名稱爲Active Docs。

Answer 2

從Mashery檢出IO/Docs。

Mashery I/O Docs是下一代API文檔和探索，它允許開發人員直接從您的文檔執行實時API調用。認爲文檔符合測試和調試要求，所有這些都在一個方便的交互式界面中。

查看Parse API Docs查看另一個偉大文檔的例子。

此外，我們花了很多時間設計FullContact API Docs。我們也使用Apigee Live API Console。

Answer 3

這是API文件建立（Rails4和Rails5）

ApiDoco https://rubygems.org/gems/apidoco/versions/1.2.0一個有用的寶石。

這是非常容易安裝和具有良好的用戶體驗。