From 3456909fe753518c2d9e7702de177aca4a250362 Mon Sep 17 00:00:00 2001 From: Andy Wilkinson Date: Tue, 26 Jul 2022 13:14:32 +0100 Subject: [PATCH] List samples in main README --- README.md | 45 +++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 41 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 6366fbf..e5b9c69 100644 --- a/README.md +++ b/README.md @@ -6,14 +6,51 @@ This repository contains a number of samples for [Spring REST Docs][1]. Each sample is a standalone project in a subdirectory of this repository. They are built using Spring Boot. +### MockMvc + +| Sample | Build System | Description | +| ----------------------------------- | ------------ | ----------- | +| [restful-notes-spring-data-rest][2] | Maven | Demonstrates the creation of a getting started guide and an API guide for a service implemented with [Spring Data REST][3]. | +| [restful-notes-spring-hateoas][4] | Gradle | Demonstrates the creation of a getting started guide and an API guide for a service implemented with [Spring HATEOAS][5]. | + +### WebTestClient + +| Sample | Build System | Description | +| ---------------------| ------------ | ----------- | +| [web-test-client][6] | Gradle | Demonstrates the use of Spring REST Docs with Spring WebFlux’s WebTestClient. | + +### REST Assured + +| Sample | Build System | Description | +| ------------------| ------------ | ----------- | +| [rest-assured][7] | Gradle | Demonstrates the use of Spring REST Docs with [REST Assured][8]. | + +### Advanced + +| Sample | Build System | Description | +| -------------------------| ------------ | ----------- | +| [restful-notes-slate][9] | Gradle | Demonstrates the use of Spring REST Docs with Markdown and [Slate][10]. | +| [testng][11] | Grade | Demonstrates the use of Spring REST Docs with [TestNG][12]. | + ## Contributing -Contributors to this repository agree to uphold its [code of conduct][2]. +Contributors to this repository agree to uphold its [code of conduct][13]. ## Licence -The Spring REST Docs Samples are open source software released under the [Apache 2.0 license][3]. +The Spring REST Docs Samples are open source software released under the [Apache 2.0 license][14]. [1]: https://github.com/spring-projects/spring-restdocs -[2]: CODE_OF_CONDUCT.md -[3]: https://www.apache.org/licenses/LICENSE-2.0.html +[2]: restful-notes-spring-data-rest +[3]: https://spring.io/projects/spring-data-rest/ +[4]: restful-notes-spring-hateoas +[5]: https://spring.io/projects/spring-hateoas/ +[6]: restful-notes-slate +[7]: rest-assured +[8]: https://rest-assured.io +[9]: restful-notes-slate +[10]: https://github.com/slatedocs/slate +[11]: testng +[12]: https://testng.org/doc/ +[13]: CODE_OF_CONDUCT.md +[14]: https://www.apache.org/licenses/LICENSE-2.0.html