生成和发布基于Ruby的REST API文档(Generate and publish Ruby b

什么是时尚的年轻人使用时下轻松解析/生成/发布的REST API？ 我接过一看扬鞭 ，它看起来不错，但离我的角度来看它不适合红宝石OK。 也许我是错了，我失去了一些东西，帮助将不胜感激。

Answer 1:

听起来像是你没有一个API了吗？ 如果是这样的话，这是我推荐的方法。

• 通过使用创建的API 接口 招摇的规范 。 为此，您可以在不使用的服务器， 在这里看到 。

• 验证通过接口招摇的UI 。 这可以让你看到你所定义的所有端点（当然，没有编码，除了JSON文件！）

• 一旦你有你想要的界面，使用招摇，代码生成来构建服务器的废止版本。 目前有模板的NodeJS和Scalatra的与更多的道路上。 制作一个新的服务器生成器只需创建/修改某些小胡子模板的问题。

• 您还可以生成与招摇，代码生成客户端。

这样做的好处是，你可以做你的API接口驱动开发。 构建接口和填补空白。 该管道为你做了。

Answer 2:

我们刚开始玩apipie这一点。 到目前为止似乎相当整齐。

Answer 3:

扬鞭可以用红宝石被用作客户端自动从符合扬鞭服务器生成的客户端库https://github.com/wordnik/swagger-codegen

如果您使用的回报率比我想你应该看看https://github.com/elc/rapi_doc ，但并不好用。

Answer 4:

请看看ApiDoco宝石（ https://github.com/72pulses/apidoco/ ）的文档。 这是很容易设置，并且具有良好的用户体验。

文章来源: Generate and publish Ruby based REST APIs documentation