Engineering
Releases
News and Events

Spring REST Docs 1.0.0.RELEASE

I’m delighted to announce that Spring REST Docs 1.0.0.RELEASE has been released. It’s available from Maven Central and our release repository.

What is Spring REST Docs?

Spring REST Docs helps you to document RESTful services. It combines hand-written documentation written with Asciidoctor and auto-generated snippets produced with Spring MVC Test. This approach frees you from the limitations imposed by tools like Swagger. It helps you to produce documentation that is accurate, concise, and well-structured. This documentation then allows your users to get the information they need with a minimum of fuss.

If you’d like to see some documentation produced using Spring REST Docs, please look at the sample API guide and Getting Started Guide for a simple RESTful notes service.

Getting started

To get started with Spring REST Docs, please refer to the getting started section of the reference documentation.

Thank you

My sincere thanks to the members of the Spring community who have helped to shape Spring REST Docs 1.0. It would not be the same without your feature suggestions, pull requests, and bug reports. Thank you.

comments powered by Disqus