我正在研究Ruby-on-Rails API项目,我想从我的代码中生成API文档,并将其上传到readme.io,这样它是动态且自动化的。
readme.io支持通过Swagger 2和OAS 3 API Specification文件的URL上传API文档。 readme.io建议使用Swagger Inline创建Swagger / OAS文件,但这是一个npm软件包。我可以将其包含在我的Rails项目中,但是我更喜欢使用Ruby gem,因为文档需要从Ruby代码生成。
您对此工作流程有何建议?