Find file History
Latest commit c518932 Nov 21, 2018

README.md

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/source/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.