76dd0cc579
The ordering of parameters in the path is important so, without seeing the path and the order in which the parameters appear, documentation for the individual parameters is of limited use. This commit enhances the path parameters snippet to include the request’s path, minus any query string, in the snippet. By default, the path is rendered as the title of the parameters table. As with other snippets, this can be customized by providing a custom template for the snippet. Closes gh-103
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.