Merge pull request #6 from LinuxSuRen/chore/openapi

chore: add openapi support

Author: LinuxSuRen

README.md

@@ -6,3 +6,9 @@ Run E2E testing:
 ```shell
 make build-image test-e2e
 ```
+
+## OpenAPI
+You can visit the swagger UI with the following address:
+
+* https://localhost:8080/swagger-ui/index.html
+* https://localhost:8080/v3/api-docs

e2e/entrypoint.sh

@@ -3,7 +3,7 @@ set -e
 
 mkdir -p /var/data
 
-atest run -p test-suite.yaml --report md
+atest run -p test-suite.yaml --report md --swagger-url "${SERVER}/v3/api-docs" --level debug
 
 # cannot get the token in a pr
 # if [[ "$PULL_REQUEST" == "" || "$GITHUB_TOKEN" == "" ]];

pom.xml

@@ -22,6 +22,12 @@
 			<artifactId>spring-boot-starter-web</artifactId>
 		</dependency>
 
+		<dependency>
+    <groupId>org.springdoc</groupId>
+    <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
+    <version>2.2.0</version>
+		</dependency>
+
 		<dependency>
 			<groupId>org.springframework.boot</groupId>
 			<artifactId>spring-boot-starter-test</artifactId>