Auto generate REST api documentation via RAML from Spring MVC controllers

Question

I am new to RAML. I want to auto generate my REST api documentation via RAML from my Spring MVC controllers. I know SpringFox has annotation based support for Swagger to auto generate api docs for spring mvc; Do we have a similar framework to auto generate RAML based api docs from spring controllers?

Thanks, Lina

Answer 1

I think RAML does note have a framework like SpringFox that generates a swagger from a Spring Controller.

There is a framework that generates a HTTP from a RAML like a swagger-ui.

This the framework: https://github.com/cybertk/grunt-raml2html

Answer 2

Another alternative that was open sourced recently is https://github.com/ePages-de/restdocs-raml. It is an extension to Spring REST Docs and generates RAML out of tests for Spring MVC controller.

Answer 3

You can try the github project springmvc-raml-plugin for maven https://github.com/phoenixnap/springmvc-raml-plugin

The plugin supports Raml 0.8, haven't found anything for RAML 1.0