生成并发布基于Ruby的REST API文档。

Question

20

如今，流行的技术是用什么来轻松解析、生成和发布REST API？我看了一下Swagger，它看起来不错，但我认为它与Ruby不太匹配。也许我错了，可能是我漏掉了某些东西，希望得到帮助。

- jpemberthy

1

听起来不错，但似乎需要很多工作来设置。 - Ismael

确实，它看起来很棒，但是它有很多依赖项，我想避免。 - jpemberthy

4个回答

8

我们刚刚开始使用apipie。到目前为止，这个工具看起来相当不错。

- Michael Shimmins

谢谢，看起来很有前途，我会记在心里，留待将来的项目使用。当我发布问题时，我已经在使用Swagger来开发我的应用程序了。 - jpemberthy

6

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

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

- Fivell

嘿，谢谢你的回答。我想我会尝试使用 rapi_doc。它看起来没有 Swagger 那么性感，但至少它的设置要简单得多。 - jpemberthy

2

那个 rapi_doc 的链接失效了。我在各种地方找到了它的分叉版本，例如 https://github.com/phuc/rapi_doc，看起来自从2008年以来它并没有得到维护。 - Harry Wood

5

请查看ApiDoco gem（https://github.com/72pulses/apidoco/）以获取文档。它很容易设置并具有良好的用户体验。

- sufinsha

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- fehguy · Accepted Answer

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

使用 swagger-specification 创建 API 的接口。您可以在不使用服务器的情况下完成此操作，see here。
使用 swagger-ui 验证接口。这样可以看到您定义的所有端点（除了 json 文件之外，无需编码！）
一旦您拥有所需的接口，使用 swagger-codegen 构建您的服务器的桩版本。目前有 nodejs 和 scalatra 的模板，并且还有更多的模板正在开发中。创建/修改一些 mustache 模板即可制作新的服务器生成器。
您还可以使用 swagger-codegen 生成客户端。

这样做的好处是，你可以进行基于接口的API开发。构建接口并填充空白部分，而不必自己处理底层细节。