Spring REST Docs Samples

Overview

This repository contains a number of samples for Spring REST Docs 4.0 built using Spring Boot 4.0. For samples using Spring REST Docs 3.0 and Spring Boot 3.5, please see the 3.0.x branch.

MockMvc

Sample	Build System	Description
restful-notes-spring-data-rest	Maven	Demonstrates the creation of a getting started guide and an API guide for a service implemented with Spring Data REST.
restful-notes-spring-hateoas	Gradle	Demonstrates the creation of a getting started guide and an API guide for a service implemented with Spring HATEOAS.

WebTestClient

Sample	Build System	Description
web-test-client	Gradle	Demonstrates the use of Spring REST Docs with Spring WebFlux’s WebTestClient.

Advanced

Sample	Build System	Description
restful-notes-slate	Gradle	Demonstrates the use of Spring REST Docs with Markdown and Slate.
testng	Gradle	Demonstrates the use of Spring REST Docs with TestNG.

Contributing

Contributors to this repository agree to uphold its code of conduct.

Licence

The Spring REST Docs Samples are open source software released under the Apache 2.0 license.