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

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

Источник

2 ответа

Решение

Существует Spring REST Docs для 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. Существует пример проекта, который демонстрирует преобразование в OpenAPI и RAML https://github.com/ePages-de/restdocs-openapi/tree/master/samples/restdocs-openapi-sample Одним из ограничений расширения является то, что в настоящее время оно работает только с Gradle.

Источник

Я знаю, что ваш вопрос устарел, но есть кое-что, что может помочь.

Вы можете использовать DocDog. Оттуда он создает RAML из существующего исходного кода. Если это SpringBoot, вы можете легко запустить его с помощью -lang=spring. Если это простой JAVA, вы можете добавлять комментарии к своему коду (см. Readme.md или примеры), чтобы DogDoc мог понять.

Пусть это вам поможет: https://github.com/skalski/docdog

Источник
Другие вопросы по тегам