The primary goal of this project is to make it easy to document RESTful services by combining content that's been hand-written using Asciidoctor with auto-generated examples produced with the Spring MVC Test framework. The result is intended to be an easy-to-read user guide, akin to GitHub's API documentation for example, rather than the fully automated, dense API documentation produced by tools like Swagger.

For a broader introduction see the Documenting RESTful APIs presentation. Both the slides and a video recording are available.

To learn more about Spring REST Docs, please consult the reference documentation.

Spring REST Docs requires Java 7 or later and is built using Gradle:

./gradlew build

Pull requests are welcome. Please see the contributor guidelines for details.

Spring REST Docs is open source software released under the Apache 2.0 license.