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

19
testng/README.md → testng/README.adoc
View File

@@ -1,17 +1,18 @@
# REST Assured Sample
A basic application that demonstrates using Spring REST Docs with [TestNG][1].
= TestNG Sample
A basic application that demonstrates using Spring REST Docs with https://testng.org/doc/[TestNG].
## Building and Running the Sample
You will need Java 17 to build and run the sample.
It is build using Gradle:
== Building the Sample
```
You will need Java 17 to build the sample.
It is built using Gradle:
[source]
----
./gradlew build
```
----
As part of the build, a file named `build/docs/asciidoc/index.html` is created.
It is produced using Asciidoctor and includes snippets generated by the sample's tests using Spring REST Docs.
[1]: https://testng.org/doc/