Merge pull request #10 from bsayli/feature/openapi-custom-type-mapping

🧹 refactor(client): remove redundant DTOs & clean generated imports (#9)

Author: bsayli

customer-service-client/.openapi-generator-ignore

@@ -1,3 +1,4 @@
+# existing patterns
 **/.github/**
 **/gradle/**
 **/.gradle/**
@@ -15,4 +16,12 @@
 **/git_push.sh
 **/README.md
 **/.openapi-generator/**
-!src/gen/java/main/**
+!src/gen/java/**
+
+# --- Custom additions for generated DTO cleanup ---
+# ignore these generated models regardless of location
+**/src/gen/java/**/generated/dto/Page*.java
+**/src/gen/java/**/generated/dto/ServiceResponse.java
+**/src/gen/java/**/generated/dto/ServiceResponseVoid.java
+**/src/gen/java/**/generated/dto/Meta.java
+**/src/gen/java/**/generated/dto/Sort.java

customer-service-client/README.md

@@ -178,11 +178,11 @@ public class CustomerClientAdapterImpl implements CustomerClientAdapter {
     @Override
     public ServiceClientResponse<Page<CustomerDto>> getCustomers(
             String name, String email, Integer page, Integer size,
-            SortField sortBy, SortDirection direction) {
+            ClientSortField sortBy, ClientSortDirection direction) {
         return api.getCustomers(
                 name, email, page, size,
-                sortBy != null ? sortBy.value() : SortField.CUSTOMER_ID.value(),
-                direction != null ? direction.value() : SortDirection.ASC.value());
+                sortBy != null ? sortBy.value() : ClientSortField.CUSTOMER_ID.value(),
+                direction != null ? direction.value() : ClientSortDirection.ASC.value());
     }
 }
 ```
@@ -252,6 +252,22 @@ try {
 
 ---
 
+### 🧹 Ignoring Redundant Generated DTOs
+
+The following patterns in [`.openapi-generator-ignore`](.openapi-generator-ignore) prevent redundant DTOs from being regenerated.
+These classes already exist in the shared `common` package and are excluded from code generation.
+
+```bash
+# --- Custom additions for generated DTO cleanup ---
+**/src/gen/java/**/generated/dto/Page*.java
+**/src/gen/java/**/generated/dto/ServiceResponse.java
+**/src/gen/java/**/generated/dto/ServiceResponseVoid.java
+**/src/gen/java/**/generated/dto/Meta.java
+**/src/gen/java/**/generated/dto/Sort.java
+```
+
+---
+
 ## 📚 Notes
 
 * **Toolchain:** Java 21, Spring Boot 3.4.10, OpenAPI Generator 7.16.0

customer-service-client/pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>io.github.bsayli</groupId>
     <artifactId>customer-service-client</artifactId>
-    <version>0.7.0</version>
+    <version>0.7.2</version>
     <name>customer-service-client</name>
     <description>Generated client (RestClient) using generics-aware OpenAPI templates</description>
     <packaging>jar</packaging>
@@ -20,7 +20,7 @@
         <openapi.generator.version>7.16.0</openapi.generator.version>
 
         <jakarta.validation.version>3.1.1</jakarta.validation.version>
-        <jakarta.annotation-api.version>3.0.0</jakarta.annotation-api.version>
+        <jakarta.annotation-api.version>${spotless-maven-plugin.version}</jakarta.annotation-api.version>
         <mockwebserver.version>5.1.0</mockwebserver.version>
         <httpclient5.version>5.5</httpclient5.version>
         <junit-jupiter.version>5.13.4</junit-jupiter.version>
@@ -32,9 +32,11 @@
         <build.helper.plugin.version>3.6.0</build.helper.plugin.version>
         <maven.resources.plugin.version>3.3.1</maven.resources.plugin.version>
         <maven.dependency.plugin.version>3.8.1</maven.dependency.plugin.version>
+        <spotless-maven-plugin.version>3.0.0</spotless-maven-plugin.version>
 
         <openapi.templates.upstream>${project.build.directory}/upstream-templates</openapi.templates.upstream>
         <openapi.templates.effective>${project.build.directory}/effective-templates</openapi.templates.effective>
+
     </properties>
 
     <dependencies>
@@ -217,6 +219,7 @@
                                 <additionalProperty>commonPackage=io.github.bsayli.openapi.client.common
                                 </additionalProperty>
                             </additionalProperties>
+                            <ignoreFileOverride>${project.basedir}/.openapi-generator-ignore</ignoreFileOverride>
                         </configuration>
                     </execution>
                 </executions>
@@ -241,7 +244,31 @@
                     </execution>
                 </executions>
             </plugin>
+            <plugin>
+                <groupId>com.diffplug.spotless</groupId>
+                <artifactId>spotless-maven-plugin</artifactId>
+                <version>${spotless-maven-plugin.version}</version>
 
+                <configuration>
+                    <java>
+                        <includes>
+                            <include>target/generated-sources/openapi/src/gen/java/**/*.java</include>
+                        </includes>
+                        <removeUnusedImports>
+                            <engine>cleanthat-javaparser-unnecessaryimport</engine>
+                        </removeUnusedImports>
+                    </java>
+                </configuration>
+                <executions>
+                    <execution>
+                        <id>spotless-apply-generated</id>
+                        <phase>process-sources</phase>
+                        <goals>
+                            <goal>apply</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-compiler-plugin</artifactId>

customer-service-client/src/main/java/io/github/bsayli/openapi/client/adapter/CustomerClientAdapter.java

@@ -2,8 +2,8 @@
 
 import io.github.bsayli.openapi.client.common.Page;
 import io.github.bsayli.openapi.client.common.ServiceClientResponse;
-import io.github.bsayli.openapi.client.common.sort.SortDirection;
-import io.github.bsayli.openapi.client.common.sort.SortField;
+import io.github.bsayli.openapi.client.common.sort.ClientSortDirection;
+import io.github.bsayli.openapi.client.common.sort.ClientSortField;
 import io.github.bsayli.openapi.client.generated.dto.CustomerCreateRequest;
 import io.github.bsayli.openapi.client.generated.dto.CustomerDeleteResponse;
 import io.github.bsayli.openapi.client.generated.dto.CustomerDto;
@@ -22,8 +22,8 @@ ServiceClientResponse<Page<CustomerDto>> getCustomers(
       String email,
       Integer page,
       Integer size,
-      SortField sortBy,
-      SortDirection direction);
+      ClientSortField sortBy,
+      ClientSortDirection direction);
 
   ServiceClientResponse<CustomerDto> updateCustomer(
       Integer customerId, CustomerUpdateRequest request);

customer-service-client/src/main/java/io/github/bsayli/openapi/client/adapter/config/CustomerApiClientConfig.java

@@ -21,7 +21,6 @@
 
 @Configuration
 public class CustomerApiClientConfig {
-  
 
   @Bean
   RestClientCustomizer problemDetailStatusHandler(ObjectMapper om) {

customer-service-client/src/main/java/io/github/bsayli/openapi/client/adapter/impl/CustomerClientAdapterImpl.java

@@ -3,8 +3,8 @@
 import io.github.bsayli.openapi.client.adapter.CustomerClientAdapter;
 import io.github.bsayli.openapi.client.common.Page;
 import io.github.bsayli.openapi.client.common.ServiceClientResponse;
-import io.github.bsayli.openapi.client.common.sort.SortDirection;
-import io.github.bsayli.openapi.client.common.sort.SortField;
+import io.github.bsayli.openapi.client.common.sort.ClientSortDirection;
+import io.github.bsayli.openapi.client.common.sort.ClientSortField;
 import io.github.bsayli.openapi.client.generated.api.CustomerControllerApi;
 import io.github.bsayli.openapi.client.generated.dto.*;
 import org.springframework.stereotype.Service;
@@ -30,7 +30,7 @@ public ServiceClientResponse<CustomerDto> getCustomer(Integer customerId) {
 
   @Override
   public ServiceClientResponse<Page<CustomerDto>> getCustomers() {
-    return getCustomers(null, null, 0, 5, SortField.CUSTOMER_ID, SortDirection.ASC);
+    return getCustomers(null, null, 0, 5, ClientSortField.CUSTOMER_ID, ClientSortDirection.ASC);
   }
 
   @Override
@@ -39,16 +39,16 @@ public ServiceClientResponse<Page<CustomerDto>> getCustomers(
       String email,
       Integer page,
       Integer size,
-      SortField sortBy,
-      SortDirection direction) {
+      ClientSortField sortBy,
+      ClientSortDirection direction) {
 
     return api.getCustomers(
         name,
         email,
         page,
         size,
-        sortBy != null ? sortBy.value() : SortField.CUSTOMER_ID.value(),
-        direction != null ? direction.value() : SortDirection.ASC.value());
+        sortBy != null ? sortBy.value() : ClientSortField.CUSTOMER_ID.value(),
+        direction != null ? direction.value() : ClientSortDirection.ASC.value());
   }
 
   @Override

customer-service-client/src/main/java/io/github/bsayli/openapi/client/adapter/support/ProblemDetailSupport.java

@@ -20,7 +20,7 @@ private ProblemDetailSupport() {}
   public static ProblemDetail extract(ObjectMapper om, ClientHttpResponse response) {
     ProblemDetail pd;
     MediaType contentType =
-            Optional.ofNullable(response.getHeaders().getContentType()).orElse(MediaType.ALL);
+        Optional.ofNullable(response.getHeaders().getContentType()).orElse(MediaType.ALL);
     HttpStatusCode status;
 
     try {
@@ -39,10 +39,10 @@ public static ProblemDetail extract(ObjectMapper om, ClientHttpResponse response
       }
     } catch (IOException e) {
       log.warn(
-              "Unable to deserialize ProblemDetail (status={}, contentType={}); using generic fallback",
-              status,
-              contentType,
-              e);
+          "Unable to deserialize ProblemDetail (status={}, contentType={}); using generic fallback",
+          status,
+          contentType,
+          e);
       pd = fallback(status, "Unparseable problem response");
     } catch (Exception e) {
       log.warn("Unexpected error while parsing ProblemDetail", e);
@@ -59,4 +59,4 @@ private static ProblemDetail fallback(HttpStatusCode status, String detail) {
     pd.setDetail(detail);
     return pd;
   }
-}
+}

customer-service-client/src/main/java/io/github/bsayli/openapi/client/common/sort/ClientSort.java

@@ -1,13 +1,13 @@
 package io.github.bsayli.openapi.client.common.sort;
 
-public record ClientSort(SortField field, SortDirection direction) {
+public record ClientSort(ClientSortField field, ClientSortDirection direction) {
 
   public ClientSort {
     if (field == null) {
-      field = SortField.CUSTOMER_ID;
+      field = ClientSortField.CUSTOMER_ID;
     }
     if (direction == null) {
-      direction = SortDirection.ASC;
+      direction = ClientSortDirection.ASC;
     }
   }
 }

customer-service-client/src/main/java/io/github/bsayli/openapi/client/common/sort/SortDirection.java renamed to customer-service-client/src/main/java/io/github/bsayli/openapi/client/common/sort/ClientSortDirection.java

@@ -1,12 +1,12 @@
 package io.github.bsayli.openapi.client.common.sort;
 
-public enum SortDirection {
+public enum ClientSortDirection {
   ASC("asc"),
   DESC("desc");
 
   private final String value;
 
-  SortDirection(String value) {
+  ClientSortDirection(String value) {
     this.value = value;
   }
 

customer-service-client/src/main/java/io/github/bsayli/openapi/client/common/sort/SortField.java renamed to customer-service-client/src/main/java/io/github/bsayli/openapi/client/common/sort/ClientSortField.java

@@ -1,13 +1,13 @@
 package io.github.bsayli.openapi.client.common.sort;
 
-public enum SortField {
+public enum ClientSortField {
   CUSTOMER_ID("customerId"),
   NAME("name"),
   EMAIL("email");
 
   private final String value;
 
-  SortField(String value) {
+  ClientSortField(String value) {
     this.value = value;
   }