From c46507d8ee93f842d847ffb5eb898e373f3218e8 Mon Sep 17 00:00:00 2001 From: rick Date: Mon, 4 Dec 2023 09:19:33 +0000 Subject: [PATCH] chore: add openapi support --- README.md | 6 ++++++ e2e/entrypoint.sh | 2 +- pom.xml | 6 ++++++ 3 files changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index effb21c..66423b2 100644 --- a/README.md +++ b/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 diff --git a/e2e/entrypoint.sh b/e2e/entrypoint.sh index bbb79c9..e95b878 100755 --- a/e2e/entrypoint.sh +++ b/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" == "" ]]; diff --git a/pom.xml b/pom.xml index c2ef12b..a9fb510 100644 --- a/pom.xml +++ b/pom.xml @@ -22,6 +22,12 @@ spring-boot-starter-web + + org.springdoc + springdoc-openapi-starter-webmvc-ui + 2.2.0 + + org.springframework.boot spring-boot-starter-test