Ruby gem для генерации документа Swagger 2 / OpenAPI-Specification 3 - PullRequest
0 голосов
/ 11 февраля 2019

Я работаю над проектом API Ruby-on-Rails и хочу сгенерировать документацию по API из своего кода и загрузить ее в readme.io, чтобы она была динамичной и автоматизированной.

readme.ioподдерживает загрузку документации API через URL для файла спецификации API Swagger 2 и OAS 3.readme.io рекомендует использовать Swagger Inline для создания файла Swagger / OAS, но это пакет npm.Я мог бы включить это в свой проект Rails, но я бы предпочел работать с гемом Ruby, поскольку документация должна быть сгенерирована из кода Ruby.

Что вы рекомендуете для этого рабочего процесса?

...