什么是生成简单API文档的ruby gem?

时间:2017-01-26 13:43:23

标签: ruby-on-rails ruby rest api ruby-on-rails-4

是否有任何简单的红宝石宝石能够:

  1. 根据路径和API控制器操作上方的注释动态生成API文档。我希望代码中的文档适用于新开发人员,而且我不想仅为API文档维护单独的视图。

  2. 在应用中的单独路线下显示API文档网站。我不想仅仅为了公开API文档而运行单独的api-documentation-server。

  3. 显示自定义评论。如果我想写一个API端点的详细说明。所以,我不想要只显示API端点和请求/响应的文档。

  4. 在JSON中指定请求和响应示例。包括为各种失败条件指定多个响应示例。

  5. (奖金)在文件评论中解释Markdown。

  6. (奖金)使用各种语言生成并显示请求每个API端点的代码,例如:Ruby,Swift。

  7. (奖金)通过API文档网站针对API运行实际请求。

  8. PS:这是针对REST API的,但是对于一些自定义路由,如果它在实践中应该有所不同。我正在使用Rails。

2 个答案:

答案 0 :(得分:1)

我假设您正在使用Rails(来自问题中的标签)。

我已使用此Apipie为我的RAILS后端服务创建文档。你的前4分很好。他们声称他们也支持Markup语言。我还没试过。

答案 1 :(得分:1)

我一直都喜欢使用Swagger