Files

Andy Wilkinson 41d537d06a Raise the minimum supported version of Spring Framework to 5.0

This commit upgrades to Spring Framework 5.0.0.RC1. It also upgrades
the Spring Boot-based samples to use Spring Boot 2.0.0.M1 which
supports Spring Framework 5. Lastly, it upgrades a number of
third-party dependencies to align with Spring Framework 5 and Spring
Boot 2.

Closes gh-386

2017-05-18 16:46:03 +02:00

gradle/wrapper

Upgrade main build and Gradle-based samples to Gradle 3.4.1

2017-03-23 11:59:13 +00:00

slate

Upgrade Slate sample to Slate 1.5

2017-03-04 22:13:46 +00:00

src

Fix the Slate sample's tests

2017-03-04 21:43:12 +00:00

build.gradle

Raise the minimum supported version of Spring Framework to 5.0

2017-05-18 16:46:03 +02:00

gradlew

Upgrade main build and Gradle-based samples to Gradle 3.4.1

2017-03-23 11:59:13 +00:00

gradlew.bat

Upgrade main build and Gradle-based samples to Gradle 3.4.1

2017-03-23 11:59:13 +00:00

README.md

Add a sample showing how to use Spring REST Docs with Slate

2016-02-15 17:52:08 +00:00

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