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解决方案中使用.