7

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

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

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

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

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

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

对象：组

路线：发布/创建

参数：组的名称

输出：

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

谢谢

4

2 回答 2

1

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

于 2013-03-09T06:34:29.260 回答
1

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

于 2013-03-09T13:27:12.780 回答