Spring REST Docs

2.0.1

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.

Quick start

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.1 CURRENT GA Reference Doc. API Doc.
2.0.2 SNAPSHOT Reference Doc. API Doc.
1.2.5 SNAPSHOT Reference Doc. API Doc.
1.2.4 GA Reference Doc. API Doc.