support to show openapi (#19)

Co-authored-by: rick <LinuxSuRen@users.noreply.github.com>

Author: LinuxSuRen

README.md

@@ -7,6 +7,11 @@ Run E2E testing:
 make build-image test-e2e
 ```
 
+## OpenAPI definition
+You can visit it via: http://localhost:8080/v3/api-docs
+
+or visit Swagger UI via: http://localhost:8080/swagger-ui/index.html
+
 ## GraphQL
 You can visit it via: http://localhost:8080/graphiql?path=/graphql
 

e2e/test-suite.yaml

@@ -9,6 +9,14 @@ items:
 - name: health
   request:
     api: /health
+- name: healthJson
+  request:
+    api: /health.json
+    header:
+      Authorization: "{{ .param.auth }}"
+  expect:
+    body: |
+      {"message":"OK"}
 - name: toLowerWithoutParam
   request:
     api: /lower

pom.xml

@@ -47,6 +47,12 @@
 			<version>1.1.0</version>
         </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>

src/main/java/io/github/devopsws/demo/model/Message.java

@@ -0,0 +1,17 @@
+package io.github.devopsws.demo.model;
+
+public class Message {
+    private String message;
+
+    public Message(String message) {
+        this.message = message;
+    }
+
+    public String getMessage() {
+        return this.message;
+    }
+
+    public void setMessage(String message) {
+        this.message=message;
+    }
+}

src/main/java/io/github/devopsws/demo/service/HealthService.java

@@ -2,11 +2,17 @@
 
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.RestController;
+import io.github.devopsws.demo.model.Message;
 
 @RestController
 public class HealthService {
 	@GetMapping("/health")
 	public String health() {
 		return "OK";
 	}
+	
+	@GetMapping("/health.json")
+	public Message healthJSON() {
+		return new Message("OK");
+	}
 }