是否有提供用于编写 REST API 文档的标记的库？我见过几家公司使用类似的文档模式，例如：
http://www.fullcontact.com/docs/?category=person
我想知道他们是否使用相同的库或服务。本质上，该库应该基于标记文本生成用于 API 导航、搜索和显示的页面（很像 Ruby 文档的 YARD）。
这是我到目前为止发现的：
- rapi_doc 宝石。这是一篇讨论用法的文章。
问问题
3793 次
3 回答
7
你绝对应该看看Swagger。
它是开源的，被数百个 API 使用，3scale 也在其 API 管理解决方案中使用 Active Docs。
于 2013-05-13T16:48:48.027 回答
1
查看 Mashery 的IO/Docs。
Mashery I/O Docs，下一代 API 文档和探索，让开发人员可以直接从您的文档执行实时 API 调用。Think docs 满足测试和调试的需求，所有这些都在一个方便的交互式界面中。
查看Parse API Docs以获取另一个优秀文档的示例。
此外，我们花了很多时间设计FullContact API 文档。我们也使用Apigee Live API 控制台。
于 2012-06-15T16:46:30.177 回答
0
这是 api 文档（Rails4 和 Rails5）的有用 gem
ApiDoco https://rubygems.org/gems/apidoco/versions/1.2.0。
它非常易于设置并具有良好的用户体验。
于 2017-04-12T05:16:42.160 回答