Sinatra构建REST API文档

Question

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

我发现https://rubygems.org/gems/sinatra-api-docs&https://rubygems.org/gems/sinatra-croon

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

另一个选项是使用一些sinatra插件,但在生成文档时不会生成REST API特定的布局.

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

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

对象:组

路线:POST /创建

参数:组的名称

输出:

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

谢谢

Answer 1

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