Sinatra 构建 REST API 文档 [关闭]答案

【问题标题】：Sinatra build REST API documentation [closed]Sinatra 构建 REST API 文档 [关闭]
【发布时间】：2013-03-09 05:59:37
【问题描述】：

我一直在寻找可以从我的 sinatra 路由中生成 API 文档的 gem。我应该可以使用内联 cmets 指定。

但两者似乎都不适用于我的设置并且也已经过时了..

另一个选项是带有一些 sinatra 插件的 yard，但在生成文档时不会生成 REST API 特定布局。

有人知道任何工具吗？

我想为每条路线参考的所有信息：

对象：组

路由：POST /create

参数：组的名称

输出：

{
  "name": "group",
  "members": []
}

谢谢

【问题讨论】：

【解决方案1】：

我会查看Apiary.io，它看起来设计得很好，并使用 Markdown 风格的特定领域语言来描述您的 API。加上它仍处于测试阶段时免费。

【讨论】：

【解决方案2】：

你试过Sinatra Yard吗？我已经使用它，对 Yard 进行了一些修改，以生成我的 API 文档。

【讨论】：