REST文档生成

Question

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

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

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

我想知道他们是否在使用相同的图书馆或服务。本质上，库应该基于标记文本生成API导航、搜索和显示页面(就像ruby文档的庭院一样)。

这就是我到目前为止所发现的：

• 博士宝石。下面是一个讨论用法的文章。

Answer 1

你绝对应该看看昂首阔步。

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

Answer 2

请看马谢利的IO/Docs。

Mashery I/O Docs是下一代的API文档和探索，它允许开发人员直接从您的文档执行实时API调用。认为文档满足测试和调试，都在一个方便、交互的界面上。

查看解析API文档以获得另一个优秀文档的示例。

此外，我们花了很多时间设计FullContact API文档。我们也利用了控制台。

Answer 3

对于api文档(Rails4和Rails5)来说，这是一个有用的宝石。

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

它非常容易设置，并具有良好的用户体验。