5

I am new to Spring-Boot. I want to auto generate my REST api documentation into RAML from my Spring MVC controllers. Is there anything to do that? or any guide that I could use it for generating my rest api into RAML?

Improve this question

2 Answers 2

Reset to default
2

There is a Spring REST Docs to RAML extension for Spring REST Docs: https://github.com/ePages-de/restdocs-raml However, this project is not maintained anymore and the authors recommend to use their new project https://github.com/ePages-de/restdocs-openapi that converts to OpenAPI (Swagger) instead of RAML. They provide a guide on how to convert OpenAPI to RAML: https://github.com/ePages-de/restdocs-openapi#convert-to-raml There is an example project that demonstrates the conversion to OpenAPI and RAML https://github.com/ePages-de/restdocs-openapi/tree/master/samples/restdocs-openapi-sample One limitation of the extension is that it only works with Gradle at the moment.

Improve this answer
Sign up to request clarification or add additional context in comments.

1 Comment

Thanks Florian for the answer. In the meantime there is a maven plugin here. github.com/BerkleyTechnologyServices/restdocs-spec - see also the docs for this (github.com/ePages-de/restdocs-openapi#maven). Also we plan to refactor restdocs-openapi to restdocs-api-spec, and eventually we will also have RAML support there.
0

I know, your Question is outdated, but there is something that might help.

You can use DocDog. From there it creates RAML from the existing source code. If it is SpringBoot you can run it easily with -lang=spring. If it is plain JAVA you can add comments to your code (see readme.md or examples), so DogDoc can understand.

May it helps you: https://github.com/skalski/docdog

Improve this answer

Comments

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service and acknowledge you have read our privacy policy.