c3a9bdfa94
Previously, SnippetWritingResultHandler hard-coded its own logic for creating the Writer that used to write its snippet. This made it impossible to take complete control over the output location, filename suffix, etc. This commit introduces a new interface, WriterResolver, and a default implementation, StandardWriterResolver. It provides the same functionality as before, but SnippetWritingResultHandler now retrieves an instance of WriterResolver from the request's attributes. This allows users to provide their own WriterResolver implementation. Closes gh-100
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.