是否有一种方法来生成Rails api的交互式文档?

Question

我的意思是类似于生成FastApi的交互式文档，但是用于Rails API。我知道有rswag，但是要使用这个，我需要在其他文件中编写具有我的端点描述的Rspec文件，然后生成要由rswag-ui或类似的东西解释的json或xml。如果我已经用minitest完成了所有的测试呢?为Rspec重写它?

但是是否有一个简单的方法来做到这一点?比如，在我的控制器上写方法名和描述，以便OAS生成器读取?不用关心每次改变控制器参数时更新OAS JSON文件，比如路由或响应因为它会自动更新。当然还包括项目中的UI。

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

Answer 1

我使用Apipie生成swagger文件和本地文档，您可以在它的演示中看到。你基本上编写ruby代码来生成文档。