3ac4a1acad
Rather than requiring an output directory to be explcitly configured, a default is now automatically configured based on the build tool that's being used. When using Gradle, snippets will be generated in build/generated-snippets. When using Maven, snippets will be generated in target/generated-snippets. See gh-297
REST Notes Slate
This sample shows how to document a RESTful API using Spring REST Docs and Slate.
The sample can be built with Gradle, but requires Ruby and the bundler gem to
be installed.
Quickstart
./gradlew build
open build/docs/api-guide.html
Details
The bulk of the documentation is written in Markdown in the file named slate/api-guide.md.erb. When the documentation is built, snippets generated by Spring REST Docs in the ApiDocumentation tests are incorporated into this documentation by ERB. The combined Markdown document is then turned into HTML.