REST API文檔生成

Question

是否有一個庫提供用於編寫​​REST API文檔的標記？ 我見過幾家公司使用類似的文檔模式，例如：

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

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

我想知道他們是否使用相同的庫或服務。 本質上，庫應該基於標記文本生成用於API導航，搜索和顯示的頁面（非常類似於用於ruby文檔的YARD）。

這是我到目前為止所發現的：

• rapi_doc gem 。 這是一篇討論用法的文章 。

Answer 1

你一定要看看Swagger 。

它是開源的，由數百個API使用，3scale也在其名為Active Docs的API Management解決方案中使用。

Answer 2

查看Mashery的IO / Docs 。

Mashery I / O Docs是下一代API文檔和探索，它允許開發人員直接從您的文檔執行實時API調用。 認為文檔可以在一個方便的交互式界面中進行測試和調試。

查看Parse API Docs以獲取精彩文檔的另一個示例。

此外，我們花了很多時間設計FullContact API文檔 。 我們也使用Apigee Live API控制台 。

Answer 3

這是api documentaion（Rails4和Rails5）的有用寶石

ApiDoco https://rubygems.org/gems/apidoco/versions/1.2.0 。

它易於設置並具有良好的用戶體驗。