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 of the documentation produced 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.

Spring Boot Config

Spring Boot provides an @AutoConfigureRestDocs annotation to leverage Spring REST Docs in your tests.

Quickstart Your Project

Bootstrap your application with Spring Initializr.

Documentation

Each Spring project has its own; it explains in great details how you can use project features and what you can achieve with them.

2.0.6.RELEASE CURRENT GA	Reference Doc.	API Doc.
3.0.0-SNAPSHOT SNAPSHOT	Reference Doc.	API Doc.
3.0.0-M4 PRE	Reference Doc.	API Doc.
2.0.7.BUILD-SNAPSHOT SNAPSHOT	Reference Doc.	API Doc.

Branch	Initial Release	End of Support	End Commercial Support *
3.0.x	2022-11-21	2023-11-21	2025-03-21
2.0.x	2017-11-28	2023-11-18	2025-03-18
1.2.x	2017-04-24	2018-04-24	2019-08-24

OSS support

Free security updates and bugfixes with support from the Spring community. See VMware Tanzu OSS support policy.

Commercial support

Business support from Spring experts during the OSS timeline, plus extended support after OSS End-Of-Life.
Publicly available releases for critical bugfixes and security issues when requested by customers.

Future release

Generation not yet released, timeline is subject to changes.

About commercial support (*)

This page shows the current state of project releases and does not define the commercial support policy. Please refer to the official support policy for more information.

Learn more about commercial support.