Spring/spring-restdocs-samples
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

List samples in main README

Browse Source
This commit is contained in:
Andy Wilkinson
2022-07-26 13:14:32 +01:00
parent 7e303ac933
commit 3456909fe7
1 changed files with 41 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

45
README.md
View File

@@ -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. Each sample is a standalone project in a subdirectory of this repository.
They are built using Spring Boot. 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 ## 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 ## 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 [1]: https://github.com/spring-projects/spring-restdocs
[2]: CODE_OF_CONDUCT.md [2]: restful-notes-spring-data-rest
[3]: https://www.apache.org/licenses/LICENSE-2.0.html [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