Автоматическая генерация документации REST API в RAML из контроллеров Spring MVC

Question

Я новичок в Spring-Boot. Я хочу автоматически сгенерировать мою документацию REST API в RAML с моих контроллеров Spring MVC. Есть что-нибудь для этого? или какое-нибудь руководство, что я мог бы использовать его для генерации моих остальных API в RAML?

Answer 1

Существует расширение Spring REST Docs to RAML для Spring REST Docs : https://github.com/ePages-de/restdocs-raml Однако этот проект больше не поддерживается, и авторы рекомендуют использовать их новый проект https://github.com/ePages-de/restdocs-openapi, который преобразуется в OpenAPI (Swagger) вместо RAML. Они предоставляют руководство о том, как преобразовать OpenAPI в RAML: https://github.com/ePages-de/restdocs-openapi#convert-to-raml Существует пример проекта, который демонстрирует преобразование в OpenAPI и RAML https://github.com/ePages-de/restdocs-openapi/tree/master/samples/restdocs-openapi-sample Одно ограничение расширения состоит в том, что оно работает только с Gradle на момент.