Ruby on rails 生成并发布基于Ruby的RESTAPI文档

Ruby on rails 生成并发布基于Ruby的RESTAPI文档,ruby-on-rails,ruby,api,rest,code-generation,Ruby On Rails,Ruby,Api,Rest,Code Generation,现在的酷孩子用什么来轻松解析/生成/发布RESTAPI?我看了一下,它看起来不错,但从我的角度来看,它不适合Ruby。也许我只是错了,我错过了一些东西,如果你能帮助我,我将不胜感激 Swagger可以与ruby作为客户端一起使用,从兼容Swagger的服务器自动生成客户端库 如果您使用的RoR比我认为您应该看到的要多,但它不容易使用。听起来您还没有API?如果是这样的话,这就是我推荐的方法 使用创建API的接口。您可以在不使用服务器的情况下执行此操作 使用验证接口。这允许您查看已定义的所有端点

现在的酷孩子用什么来轻松解析/生成/发布RESTAPI?我看了一下,它看起来不错,但从我的角度来看,它不适合Ruby。也许我只是错了,我错过了一些东西,如果你能帮助我,我将不胜感激

Swagger可以与ruby作为客户端一起使用,从兼容Swagger的服务器自动生成客户端库


如果您使用的RoR比我认为您应该看到的要多,但它不容易使用。

听起来您还没有API?如果是这样的话,这就是我推荐的方法

  • 使用创建API的接口。您可以在不使用服务器的情况下执行此操作

  • 使用验证接口。这允许您查看已定义的所有端点(仍然没有编码,json文件除外!)

  • 一旦有了所需的接口,就可以使用来构建服务器的存根版本。目前有更多的模板。制作一个新的服务器生成器只需创建/修改一些小胡子模板

  • 您还可以使用swagger codegen生成客户机


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

我们刚刚开始玩这个。到目前为止似乎还不错。

请查看ApiDoco gem()的文档。它很容易安装,并且有很好的用户体验。

似乎很棒,但它似乎确实需要很多工作才能准确地安装,它看起来很棒,但它有很多依赖项我想避免。嘿,谢谢你的回答,我想我会尝试一下
rapi_doc
。它看起来不像招摇过市那么性感,但至少它的设置要简单得多。rapi_文档链接被破坏了。我发现它在不同的地方出现了分叉,例如,看起来它自2008年以来就没有真正得到维护,但ruby原型支持现在已经可用(注意!将要进行更改以使ruby更具特色):谢谢,看起来很有希望,我将在未来的项目中记住这一点。当我发布这个问题时,我已经在为我正在谈论的应用程序招摇过市了。