ruby-on-rails - 生成和发布基于 Ruby 的 REST API 文档

Question

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

score 15 · Accepted Answer

听起来你还没有 API？如果是这种情况，这是我推荐的方法。

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

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

score 8 · Accepted Answer

8

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

于 2012-09-28T02:50:44.003 回答

score 6 · Accepted Answer

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

如果您使用 RoR，我认为您应该查看https://github.com/elc/rapi_doc，但它并不容易使用。

score 5 · Accepted Answer

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

4 回答 4