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一个有用的宝石。

这是非常容易安装和具有良好的用户体验。