feat: integrate openapi-generator-maven-plugin

paul58914080 · paul58914080 · commit 10c65f48e2a8 · 2023-08-28T13:23:26.000+05:30
diff --git a/acceptance-test/src/test/java/packagename/cucumber/ExampleStepDef.java b/acceptance-test/src/test/java/packagename/cucumber/ExampleStepDef.java
@@ -1,23 +1,25 @@
 package packagename.cucumber;
 
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.Assertions.within;
+
 import io.cucumber.datatable.DataTable;
 import io.cucumber.java8.En;
 import io.cucumber.java8.HookNoArgsBody;
+import java.time.LocalDateTime;
+import java.time.temporal.ChronoUnit;
+import java.util.List;
+import java.util.Map;
+import java.util.stream.Collectors;
 import org.springframework.boot.test.web.client.TestRestTemplate;
 import org.springframework.boot.test.web.server.LocalServerPort;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
 import packagename.domain.model.Example;
-import packagename.domain.model.ExampleInfo;
 import packagename.repository.dao.ExampleDao;
 import packagename.repository.entity.ExampleEntity;
-import packagename.rest.exception.ExampleExceptionResponse;
-
-import java.util.List;
-import java.util.Map;
-import java.util.stream.Collectors;
-
-import static org.assertj.core.api.Assertions.assertThat;
+import packagename.rest.generated.model.ExampleInfo;
+import packagename.rest.generated.model.ProblemDetail;
 
 public class ExampleStepDef implements En {
 
@@ -70,17 +72,27 @@ public ExampleStepDef(TestRestTemplate restTemplate, ExampleDao exampleDao) {
         "user requests for examples by id {string} that does not exists",
         (String code) -> {
           String url = LOCALHOST + port + API_URI + "/" + code;
-          responseEntity = restTemplate.getForEntity(url, ExampleExceptionResponse.class);
+          responseEntity = restTemplate.getForEntity(url, ProblemDetail.class);
         });
 
     Then(
         "the user gets an exception {string}",
         (String exception) -> {
           assertThat(responseEntity.getStatusCode()).isEqualTo(HttpStatus.NOT_FOUND);
-          Object body = responseEntity.getBody();
-          assertThat(body).isNotNull();
-          assertThat(body).isInstanceOf(ExampleExceptionResponse.class);
-          assertThat(((ExampleExceptionResponse) body).getMessage()).isEqualTo(exception);
+          var actualResponse = (ProblemDetail) responseEntity.getBody();
+          var expectedProblemDetail = ProblemDetail.builder()
+              .type("https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/404")
+              .status(HttpStatus.NOT_FOUND.value())
+              .detail("Example with code 10000 does not exist")
+              .instance("/api/v1/examples/10000")
+              .title("Example not found")
+              .build();
+          assertThat(actualResponse).isNotNull();
+          assertThat(actualResponse).usingRecursiveComparison()
+              .ignoringFields("timestamp")
+              .isEqualTo(expectedProblemDetail);
+          assertThat(actualResponse.getTimestamp()).isCloseTo(
+              LocalDateTime.now(), within(100L, ChronoUnit.SECONDS));
         });
 
     Then(
diff --git a/domain-api/src/main/java/packagename/domain/model/ExampleInfo.java b/domain-api/src/main/java/packagename/domain/model/ExampleInfo.java
diff --git a/domain-api/src/main/java/packagename/domain/port/RequestExample.java b/domain-api/src/main/java/packagename/domain/port/RequestExample.java
@@ -1,12 +1,12 @@
 package packagename.domain.port;
 
+import java.util.List;
 import lombok.NonNull;
 import packagename.domain.model.Example;
-import packagename.domain.model.ExampleInfo;
 
 public interface RequestExample {
 
-  ExampleInfo getExamples();
+  List<Example> getExamples();
 
   Example getExampleByCode(@NonNull Long code);
 }
diff --git a/domain/src/main/java/packagename/domain/ExampleDomain.java b/domain/src/main/java/packagename/domain/ExampleDomain.java
@@ -1,11 +1,13 @@
 package packagename.domain;
 
+import lombok.NonNull;
 import packagename.domain.exception.ExampleNotFoundException;
 import packagename.domain.model.Example;
-import packagename.domain.model.ExampleInfo;
 import packagename.domain.port.ObtainExample;
 import packagename.domain.port.RequestExample;
 
+import java.util.List;
+
 public class ExampleDomain implements RequestExample {
 
   private final ObtainExample obtainExample;
@@ -19,12 +21,12 @@ public ExampleDomain(ObtainExample obtainExample) {
   }
 
   @Override
-  public ExampleInfo getExamples() {
-    return ExampleInfo.builder().examples(obtainExample.getAllExamples()).build();
+  public List<Example> getExamples() {
+    return obtainExample.getAllExamples();
   }
 
   @Override
-  public Example getExampleByCode(Long code) {
+  public Example getExampleByCode(@NonNull Long code) {
     var example = obtainExample.getExampleByCode(code);
     return example.orElseThrow(() -> new ExampleNotFoundException(code));
   }
diff --git a/domain/src/test/java/packagename/AcceptanceTest.java b/domain/src/test/java/packagename/AcceptanceTest.java
@@ -28,10 +28,9 @@ public void getExamplesFromHardCoded() {
        ObtainExample     - right side port
     */
     var requestExample = new ExampleDomain(); // the example is hard coded
-    var exampleInfo = requestExample.getExamples();
-    assertThat(exampleInfo).isNotNull();
-    assertThat(exampleInfo.getExamples())
-        .isNotEmpty()
+    var examples = requestExample.getExamples();
+    assertThat(examples)
+        .hasSize(1)
         .extracting("description")
         .contains(
             "If you could read a leaf or tree\r\nyoud have no need of books.\r\n-- Alistair Cockburn (1987)");
@@ -50,10 +49,9 @@ public void getExamplesFromMockedStub(@Mock ObtainExample obtainExample) {
     Mockito.lenient().when(obtainExample.getAllExamples()).thenReturn(List.of(example));
     // hexagon
     var requestExample = new ExampleDomain(obtainExample);
-    var exampleInfo = requestExample.getExamples();
-    assertThat(exampleInfo).isNotNull();
-    assertThat(exampleInfo.getExamples())
-        .isNotEmpty()
+    var examples = requestExample.getExamples();
+    assertThat(examples)
+        .hasSize(1)
         .extracting("description")
         .contains(
             "I want to sleep\r\nSwat the flies\r\nSoftly, please.\r\n\r\n-- Masaoka Shiki (1867-1902)");
diff --git a/rest-adapter/pom.xml b/rest-adapter/pom.xml
@@ -34,6 +34,42 @@
   </dependencies>
   <build>
     <plugins>
+      <plugin>
+        <groupId>org.openapitools</groupId>
+        <artifactId>openapi-generator-maven-plugin</artifactId>
+        <version>6.3.0</version>
+        <executions>
+          <execution>
+            <id>generate-open-api-source</id>
+            <goals>
+              <goal>generate</goal>
+            </goals>
+            <configuration>
+              <inputSpec>${project.basedir}/src/main/resources/open-api.yaml</inputSpec>
+              <generatorName>spring</generatorName>
+              <library>spring-boot</library>
+              <schemaMappings>
+                <schemaMapping>Example=packagename.domain.model.Example</schemaMapping>
+              </schemaMappings>
+              <typeMappings>
+                <typeMapping>OffsetDateTime=java.time.LocalDateTime</typeMapping>
+              </typeMappings>
+              <apiPackage>packagename.rest.generated.api</apiPackage>
+              <modelPackage>packagename.rest.generated.model</modelPackage>
+              <configOptions>
+                <performBeanValidation>false</performBeanValidation>
+                <useSpringBoot3>true</useSpringBoot3>
+                <interfaceOnly>true</interfaceOnly>
+                <dateLibrary>java8</dateLibrary>
+                <useTags>true</useTags>
+                <openApiNullable>false</openApiNullable>
+                <additionalModelTypeAnnotations>@lombok.AllArgsConstructor @lombok.Builder @lombok.Data @lombok.NoArgsConstructor
+                </additionalModelTypeAnnotations>
+              </configOptions>
+            </configuration>
+          </execution>
+        </executions>
+      </plugin>
       <plugin>
         <groupId>com.societegenerale.commons</groupId>
         <artifactId>arch-unit-maven-plugin</artifactId>
diff --git a/rest-adapter/src/main/java/packagename/rest/ExampleResource.java b/rest-adapter/src/main/java/packagename/rest/ExampleResource.java
@@ -6,12 +6,13 @@
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
 import packagename.domain.model.Example;
-import packagename.domain.model.ExampleInfo;
 import packagename.domain.port.RequestExample;
+import packagename.rest.generated.api.ExampleApi;
+import packagename.rest.generated.model.ExampleInfo;
 
 @RestController
 @RequestMapping("/api/v1/examples")
-public class ExampleResource {
+public class ExampleResource implements ExampleApi {
 
   private final RequestExample requestExample;
 
@@ -21,7 +22,7 @@ public ExampleResource(RequestExample requestExample) {
 
   @GetMapping
   public ResponseEntity<ExampleInfo> getExamples() {
-    return ResponseEntity.ok(requestExample.getExamples());
+    return ResponseEntity.ok(ExampleInfo.builder().examples(requestExample.getExamples()).build());
   }
 
   @GetMapping("/{code}")
diff --git a/rest-adapter/src/main/java/packagename/rest/exception/ExampleExceptionHandler.java b/rest-adapter/src/main/java/packagename/rest/exception/ExampleExceptionHandler.java
@@ -1,24 +1,30 @@
 package packagename.rest.exception;
 
+import java.time.LocalDateTime;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.ExceptionHandler;
 import org.springframework.web.bind.annotation.RestControllerAdvice;
 import org.springframework.web.context.request.ServletWebRequest;
 import org.springframework.web.context.request.WebRequest;
 import packagename.domain.exception.ExampleNotFoundException;
+import packagename.rest.generated.model.ProblemDetail;
 
 @RestControllerAdvice(basePackages = {"packagename"})
 public class ExampleExceptionHandler {
 
   @ExceptionHandler(value = ExampleNotFoundException.class)
-  public final ResponseEntity<ExampleExceptionResponse> handleExampleNotFoundException(
+  public final ResponseEntity<ProblemDetail> handleExampleNotFoundException(
       final Exception exception, final WebRequest request) {
+    var problem = ProblemDetail.builder()
+        .type("https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/404")
+        .status(HttpStatus.NOT_FOUND.value())
+        .title("Example not found")
+        .detail(exception.getMessage())
+        .instance(((ServletWebRequest) request).getRequest().getRequestURI())
+        .timestamp(LocalDateTime.now())
+        .build();
     return ResponseEntity.status(HttpStatus.NOT_FOUND)
-        .body(
-            ExampleExceptionResponse.builder()
-                .message(exception.getMessage())
-                .path(((ServletWebRequest) request).getRequest().getRequestURI())
-                .build());
+        .body(problem);
   }
 }
diff --git a/rest-adapter/src/main/java/packagename/rest/exception/ExampleExceptionResponse.java b/rest-adapter/src/main/java/packagename/rest/exception/ExampleExceptionResponse.java
diff --git a/rest-adapter/src/main/resources/open-api.yaml b/rest-adapter/src/main/resources/open-api.yaml
@@ -0,0 +1,76 @@
+---
+openapi: 3.0.1
+info:
+  title: Example API Documentation
+  version: v1
+tags:
+  - name: Example
+    description: Resource to manage example
+paths:
+  "/api/v1/examples":
+    get:
+      tags:
+        - Example
+      summary: Get all examples
+      operationId: getExamples
+      responses:
+        '200':
+          description: OK
+          content:
+            "*/*":
+              schema:
+                "$ref": "#/components/schemas/ExampleInfo"
+  "/api/v1/examples/{code}":
+    get:
+      tags:
+        - Example
+      summary: Get example by code
+      operationId: getExampleByCode
+      parameters:
+        - name: code
+          in: path
+          required: true
+          schema:
+            type: integer
+            format: int64
+      responses:
+        '200':
+          description: OK
+          content:
+            "*/*":
+              schema:
+                "$ref": "#/components/schemas/Example"
+components:
+  schemas:
+    Example:
+      type: object
+      properties:
+        code:
+          type: integer
+          format: int64
+        description:
+          type: string
+    ExampleInfo:
+      type: object
+      properties:
+        examples:
+          type: array
+          items:
+            "$ref": "#/components/schemas/Example"
+    ProblemDetail:
+      type: object
+      properties:
+        type:
+          type: string
+        title:
+          type: string
+        status:
+          type: integer
+          format: int32
+        detail:
+          type: string
+        instance:
+          type: string
+        timestamp:
+          type: string
+          format: date-time
diff --git a/rest-adapter/src/test/java/packagename/rest/ExampleResourceTest.java b/rest-adapter/src/test/java/packagename/rest/ExampleResourceTest.java
