Sinatra构建REST API文档

Question

我一直在寻找宝石来从我的sinatra路线生成API文档。我应该可以使用内联注释进行指定。

我找到了https://rubygems.org/gems/sinatra-api-docs＆amp; https://rubygems.org/gems/sinatra-croon

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

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

有没有人知道他们所知道的任何工具？

我想为每条路线引用的所有信息：

对象：群组

路线：POST /创建

参数：组的名称

输出：

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

感谢

Answer 1

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

Answer 2

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