ruby-on-rails - REST API 文档生成

Question

是否有库提供用于编写​​ REST API 文档的标记？我见过几家公司使用类似的文档模式，例如:

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

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

我想知道他们是否使用相同的库或服务。本质上，该库应该根据标记文本生成用于 API 导航、搜索和显示的页面(很像用于 ruby​​ 文档的 YARD)。

这是我目前发现的:

• rapi_doc gem .这是一个 article讨论用法。

Answer 1

你绝对应该看看Swagger .

它是开源的，被数百个 API 使用，也被 3scale 在其 API 管理解决方案中以 Active Docs 的名义使用。