This sample shows you how to document a simple REST controller with Spring REST Docs.
This service is written using Spring Boot which makes it easy to get it up and running so that you can start exploring the REST API and their documentation. After you started up the service, this page is available under http://localhost:8080. The documentation explaining the REST API implemented through this service is available under http://localhost:8080/docs/index.html.
If you want to test the REST API, you can simply use Postman, curl or another HTTP client to execute some requests against this service. The necessary input to successfully execute a request and what you can expect as output is explained through the REST API documentation.
The service uses Spring REST Docs to document the public REST API. The API is implemented through class BookController. Class BookControllerDoc is using the Spring REST Docs framework to implement tests which are generating a set of snippets. These snippets are used as includes to complete the documentation located under src/main/asciidoc. The build process defined in the pom.xml generates the resulting html files which are then copied into the static content service folder to be available during runtime.
Collection of the mainly used frameworks in this project. There are more, but they are not that present inside the main use case therefore they are not listed here.
This code is open source software licensed under the Apache 2.0 License.