Sinatra 构建 REST API 文档 [已关闭]

Question

我整晚都在寻找一个 gem 来从我的 sinatra 路由生成 API 文档。我应该能够用内联注释来指定。

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

另一个选项是使用一些 sinatra 插件进行院子，但在生成文档时不会生成 REST API 特定布局。

有人有他们知道的工具吗？

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

对象：团体

路线：POST /创建

参数：群组名称

输出：

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

Answer 1

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

Answer 2

您尝试过西纳特拉庭院吗？我已经使用它（对 Yard 进行了一些修改）来生成我的 API 文档。