Skip to content

Commit c46507d

Browse files
committed
chore: add openapi support
1 parent eb36a9e commit c46507d

3 files changed

Lines changed: 13 additions & 1 deletion

File tree

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,9 @@ Run E2E testing:
66
```shell
77
make build-image test-e2e
88
```
9+
10+
## OpenAPI
11+
You can visit the swagger UI with the following address:
12+
13+
* https://localhost:8080/swagger-ui/index.html
14+
* https://localhost:8080/v3/api-docs

e2e/entrypoint.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ set -e
33

44
mkdir -p /var/data
55

6-
atest run -p test-suite.yaml --report md
6+
atest run -p test-suite.yaml --report md --swagger-url "${SERVER}/v3/api-docs" --level debug
77

88
# cannot get the token in a pr
99
# if [[ "$PULL_REQUEST" == "" || "$GITHUB_TOKEN" == "" ]];

pom.xml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,12 @@
2222
<artifactId>spring-boot-starter-web</artifactId>
2323
</dependency>
2424

25+
<dependency>
26+
<groupId>org.springdoc</groupId>
27+
<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
28+
<version>2.2.0</version>
29+
</dependency>
30+
2531
<dependency>
2632
<groupId>org.springframework.boot</groupId>
2733
<artifactId>spring-boot-starter-test</artifactId>

0 commit comments

Comments
 (0)