d3e1a0d1b6
Previously, the snippet for documenting a request’s parameters was referred to as the query parameters snippet. This was misleading as the snippet would actually document anything in the request’s parameters map, not just parameters from the request’s query string. This commit renames the snippet and the associated templates, etc so that it is now known as the request parameters snippet. This provides a more accurate reflection of it being able to document all of a request’s parameters, not just those from its query string. Closes gh-104
Spring REST Docs 
Overview
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.
Learning more
To learn more about Spring REST Docs, please consult the reference documentation.
Building from source
Spring REST Docs requires Java 7 or later and is built using Gradle:
./gradlew build
Contributing
Pull requests are welcome. Please see the contributor guidelines for details.
Licence
Spring REST Docs is open source software released under the Apache 2.0 license.