如何在不编写规格文件的情况下生成摇摇欲坠

时间:2019-01-28 05:46:47

标签: ruby-on-rails-3 swagger swagger-ui rswag

我正在寻找一个会生成swagger文档并将其显示在swagger UI上的gem,我遇到了rswag gem,但它需要存在规范文件才能生成swagger文档

如果将其放在API控制器上,是否有任何gem会自动生成swagger文档?

1 个答案:

答案 0 :(得分:0)

我构建了一个开源工具来简化此过程。该项目不是在代码级别进行集成,而是使用本地代理来分析实际的开发流量,并在观察到API中的新行为时更新您的API规范。 https://github.com/opticdev/optic

对于Rails,您唯一要做的更改是使开关不再使用:

rails server

使用Optic的启动命令启动API。

api start

当检测到新的API行为时,您可以使用我们的UI将其添加到您的规范中。 Here's an example