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

时间:2012-04-23 22:10:12

标签: ruby-on-rails ruby api rest code-generation

现在使用什么酷孩子轻松解析/生成/发布REST API?我看了一下Swagger它看起来不错,但从我的观点来看,它不适合Ruby。也许我错了,我错过了什么,帮助将不胜感激。

4 个答案:

答案 0 :(得分:15)

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

  • 使用swagger-specification为API创建界面。您可以在不使用服务器的情况下执行此操作see here

  • 使用swagger-ui验证界面。这允许您查看已定义的所有端点(仍然没有编码,除了json文件!)

  • 获得所需的界面后,使用swagger-codegen构建服务器的存根版本。目前有nodejsscalatra的模板,其中包含更多内容。制作新的服务器生成器只需要创建/修改一些胡子模板。

  • 您还可以使用swagger-codegen生成客户端。

这样做的好处在于您可以进行API的界面驱动开发。构建接口并填充空白。管道工作是为您完成的。

答案 1 :(得分:8)

我们刚开始玩apipie。到目前为止看起来非常整洁。

答案 2 :(得分:6)

Swagger可以与ruby一起用作客户端,从Swagger兼容服务器https://github.com/wordnik/swagger-codegen

自动生成客户端库

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

答案 3 :(得分:0)

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