生成和发布基于 Ruby 的 REST API 文档答案

【问题标题】：Generate and publish Ruby based REST APIs documentation生成和发布基于 Ruby 的 REST API 文档
【发布时间】：2012-04-23 22:10:11
【问题描述】：

现在很酷的孩子们使用什么来轻松解析/生成/发布 REST API？我看了一下Swagger，它看起来不错，但从我的角度来看，它不适合 Ruby。也许我错了，我错过了一些东西，我们将不胜感激。

【问题讨论】：

【解决方案1】：

听起来您还没有 API？如果是这样，这是我推荐的方法。

使用swagger-specification 为 API 创建一个接口。您可以在不使用服务器的情况下执行此操作，see here。
使用swagger-ui 验证接口。这允许您查看您定义的所有端点（仍然没有编码，除了 json 文件！）
一旦你有了你想要的接口，就可以使用swagger-codegen 来构建你的服务器的存根版本。目前有nodejs 和scalatra 的模板，更多模板即将推出。制作新的服务器生成器只需创建/修改一些 mustache 模板即可。
您还可以使用 swagger-codegen 生成客户端。

这样做的好处是您可以对 API 进行接口驱动的开发。建立接口并填空。管道已为您完成。

【讨论】：

原型 ruby 支持现已推出（注意！将进行更改以提供更多 ruby 风格）：github.com/wordnik/swagger-codegen/tree/master/samples/…

【解决方案2】：

为此，我们刚刚开始使用apipie。到目前为止看起来很整洁。

【讨论】：

【解决方案3】：

Swagger 可以与 ruby 作为客户端一起使用，以自动从 Swagger 兼容的服务器生成客户端库https://github.com/wordnik/swagger-codegen

如果你使用 RoR 比我认为你应该看看 https://github.com/elc/rapi_doc ，但它并不好用。

【讨论】：

【解决方案4】：

请查看 ApiDoco gem (https://github.com/72pulses/apidoco/) 以获取文档。它非常易于设置并且具有良好的用户体验。

【讨论】：