如何在不编写规范文件的情况下生成招摇

Question

我正在寻找一个可以生成 swagger 文档并将其显示在 swagger UI 上的 gem，我遇到了 rswag gem，但它需要提供规范文件才能生成 swagger doc

如果我将它放在 API 控制器上，是否有任何 gem 会自动生成 swagger 文档？

Answer 1

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

对于 Rails，您唯一需要做的更改是从使用进行切换：

rails server

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

api start

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