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

Use Asciidoctor for READMEs and related files

Browse Source
This commit is contained in:
Andy Wilkinson
2022-07-26 13:47:44 +01:00
parent 3456909fe7
commit 0cbcb448d5
11 changed files with 180 additions and 161 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
restful-notes-spring-data-rest/README.md → restful-notes-spring-data-rest/README.adoc
View File

@@ -1,17 +1,20 @@
# Restful Notes Spring Data REST Sample
= Restful Notes Spring Data REST Sample
A RESTful web service for creating and storing notes.
It uses hypermedia to describe the relationships between resources and to allow navigation between them.
Demonstrates using Spring REST Docs with MockMvc and Spring Data REST.
Demonstrates using Spring REST Docs with MockMvc and https://spring.io/projects/spring-data-rest/[Spring Data REST].
## Building and Running the Sample
You will need Java 17 to build and run the sample.
== Building the Sample
You will need Java 17 to build the sample.
It is built using Maven:
```
[source]
----
./mvnw verify
```
----
As part of the build, files named `build/docs/asciidoc/api-guide.html` and `build/docs/asciidoc/getting-started-guide.html` are created.
They are produced using Asciidoctor and include snippets generated by the sample's tests using Spring REST Docs.