有没有办法为 Rails API 生成交互式文档？

Question

我的意思是类似生成 FastApi 的交互式文档，但是针对 Rails API。我知道有 rswag，但要使用它，我需要在其他文件中编写带有端点描述的 Rspec 文件，然后生成 json 或 xml 以便由 rswag-ui 或类似的东西解释。如果我的测试已经全部用 minitest 进行了怎么办？为 Rspec 重写它吗？

但是有没有一种捷径可以做到这一点呢？比如，在我的控制器上写下方法名称和描述，以便 OAS 生成器读取？每次更改控制器、路由或响应的某些参数时，不必关心更新我的 OAS JSON 文件，因为它会自动更新。当然，还包括项目中的 UI。

已经存在这样的神奇工具了吗？或者处于初始状态的项目试图做类似的事情？

Answer 1

我使用 Apipie 生成 swagger 文件和本地文档，如您在其演示中看到的那样。您基本上编写 ruby 代码来生成文档。

Answer 2

两年后，我提出了这个问题，我将回答我所发现的内容并展示我决定创建的工具：

• ApiPie：不支持OAS 3.1，需要学习DSL，缺乏漂亮的UI
• swagger_yard-rails：似乎被遗弃了。
• Rswag：取决于RSpec；现在许多开发人员使用 Minitest，因为它是默认的测试框架
• 葡萄大摇大摆：需要葡萄
• rspec_api_documentation：需要 RSpec 和命令来生成文档

最后是我为满足我的要求而制作的工具：

• OasRails 尝试动态、简单且具有漂亮的 UI。所有我一直在寻找的东西。目前仍在开发中。