Demo repo to show how Spring REST Docs can be used to document an API
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.mvn/wrapper
generated-docs
src
.gitignore
README.md
mvnw
mvnw.cmd Spring AUTO Rest Docs Jul 19, 2018
pom.xml

README.md

Customers application

This a sample and simple Spring Boot application to show how we can document our Rest API using Spring Rest Docs & Spring Auto Rest Docs.

mvn clean package

Then go to the generated-docs folder and open the file index.html in a browser.

There are two test classes for CustomersController:

  • CustomersControllerTest: test to generate documentation using Spring REST Docs
  • CustomerControllerAutoDocsTest: test to generate documentation using Spring Auto REST Docs.