chore: openapi-generator 7.20.0 upgrade - Spring Boot 4, Jackson 3 (#1233)

* move project to baseline standard openapi-generator with version 7.20.0 to allow future updates
* remove obsolete features
* update default templates to support remaining functionality

Author: bbzurek

README.md

@@ -16,6 +16,16 @@ It currently consists of
 # Release Notes
 BOAT is still under development and subject to change.
 
+## 0.18.0
+* openapi-generator `7.20.0` baseline (Spring Boot 4, Jackson 3)
+* moved Java and JavaSpring templates to `7.20.0` adding remaing custom features
+* removed custom `createApiComponent` in favor of the standard `generateClientAsBean` with default set to `true`
+* removed custom `useLombokAnnotations` in favor of built-in `lombokAnnotation` template
+* removed custom `useClassLevelBeanValidation` in favor of the standard `useSpringBuiltInValidation` property
+* removed custom `useWithModifiers`, fluent setters already included in generated classes (property name methods)
+* removed unused `useProtectedFields` property
+* removed unused `useDefaultApiClient` property
+
 ## 0.17.75
 * Fixed duplicate serialization of the discriminator property in Jackson-based Java models by removing allowGetters = true from the @JsonIgnoreProperties annotation.
 * In Spring generator added support for type-level validation in collections via the `x-not-null` vendor extension to allow `@NotNull` annotations on generic type arguments.
@@ -725,7 +735,6 @@ For the `spring` generator, the additional configuration options are:
 | `useTags` | use tags for creating interface and controller classnames (Default: false) |
 | `useBeanValidation` | Use BeanValidation API annotations (Default: true) |
 | `performBeanValidation` | Use Bean Validation Impl. to perform BeanValidation (Default: false) |
-| `useClassLevelBeanValidation` | Adds @Validated annotation to API interfaces (Default: false) |
 | `useLombokAnnotations` | Use Lombok annotations to generate properties accessors and `hashCode`/`equals` methods (Default: false) |
 | `addServletRequest` | Adds ServletRequest objects to API method definitions (Default: false) |
 | `addBindingResult` | Adds BindingResult to Api method definitions' request bodies if UseBeanValidation true, for this to be effective you must configure UseBeanValidation, this is not done automatically (Default: false)|

boat-engine/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>com.backbase.oss</groupId>
         <artifactId>backbase-openapi-tools</artifactId>
-        <version>0.17.75-SNAPSHOT</version>
+        <version>0.18.0-SNAPSHOT</version>
     </parent>
     <artifactId>boat-engine</artifactId>
     <packaging>jar</packaging>

boat-maven-plugin/README.md

@@ -37,7 +37,6 @@ Same with `generate` but with opinionated defaults for Spring
             <interfaceOnly>true</interfaceOnly>
             <skipDefaultInterface>true</skipDefaultInterface>
             <useBeanValidation>true</useBeanValidation>
-            <useClassLevelBeanValidation>false</useClassLevelBeanValidation>
             <useTags>true</useTags>
             <java8>true</java8>
             <useOptional>false</useOptional>
@@ -78,7 +77,6 @@ It will generate webhook interfaces with prehook and posthook request mapping fo
             <interfaceOnly>true</interfaceOnly>
             <skipDefaultInterface>true</skipDefaultInterface>
             <useBeanValidation>true</useBeanValidation>
-            <useClassLevelBeanValidation>false</useClassLevelBeanValidation>
             <useTags>true</useTags>
             <java8>true</java8>
             <useOptional>false</useOptional>
@@ -108,7 +106,6 @@ Same with `generate` but with opinionated defaults for Rest Template Client
             <interfaceOnly>true</interfaceOnly>
             <skipDefaultInterface>true</skipDefaultInterface>
             <useBeanValidation>true</useBeanValidation>
-            <useClassLevelBeanValidation>false</useClassLevelBeanValidation>
             <useTags>true</useTags>
             <java8>true</java8>
             <useOptional>false</useOptional>
@@ -122,7 +119,7 @@ Same with `generate` but with opinionated defaults for Rest Template Client
     <configuration>
         ...
         <additionalProperties>
-            <additionalProperty>createApiComponent=false</additionalProperty>
+            <additionalProperty>restTemplateBeanName=interServiceRestTemplate</additionalProperty>
         </additionalProperties>
     </configuration>
 
@@ -198,7 +195,6 @@ Same with `generate` but with opinionated defaults for Web Client
             <interfaceOnly>true</interfaceOnly>
             <skipDefaultInterface>true</skipDefaultInterface>
             <useBeanValidation>true</useBeanValidation>
-            <useClassLevelBeanValidation>false</useClassLevelBeanValidation>
             <useTags>true</useTags>
             <java8>true</java8>
             <useOptional>false</useOptional>

boat-maven-plugin/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>com.backbase.oss</groupId>
         <artifactId>backbase-openapi-tools</artifactId>
-        <version>0.17.75-SNAPSHOT</version>
+        <version>0.18.0-SNAPSHOT</version>
     </parent>
     <artifactId>boat-maven-plugin</artifactId>
 
@@ -53,6 +53,18 @@
             <groupId>org.openapitools.openapidiff</groupId>
             <artifactId>openapi-diff-core</artifactId>
             <version>2.1.7</version>
+            <exclusions>
+                <!-- Avoid loading Apache HttpClient in plugin realm to prevent
+                     ClassRealm conflicts with Maven's own transport stack. -->
+                <exclusion>
+                    <groupId>org.apache.httpcomponents</groupId>
+                    <artifactId>httpclient</artifactId>
+                </exclusion>
+                <exclusion>
+                    <groupId>org.apache.httpcomponents</groupId>
+                    <artifactId>httpcore</artifactId>
+                </exclusion>
+            </exclusions>
         </dependency>
 
         <dependency>
@@ -360,7 +372,7 @@
             <plugin>
                 <groupId>com.backbase.oss</groupId>
                 <artifactId>boat-maven-plugin</artifactId>
-                <version>0.17.50</version>
+                <version>0.17.74</version>
                 <executions>
                     <execution>
                         <goals>

boat-maven-plugin/src/it/example/boat-generate/java-clients/java/pom.xml

@@ -15,7 +15,7 @@
     <name>BOAT :: Generate :: Java Client</name>
 
     <properties>
-        <boat-maven-plugin.supportingFilesToGenerate>ApiClient.java,BeanValidationException.java,RFC3339DateFormat.java,ServerConfiguration.java,ServerVariable.java,StringUtil.java,Authentication.java,HttpBasicAuth.java,HttpBearerAuth.java,ApiKeyAuth.java,ApiException.java,Pair.java,ApiResponse.java,JavaTimeFormatter.java</boat-maven-plugin.supportingFilesToGenerate>
+        <boat-maven-plugin.supportingFilesToGenerate>ApiClient.java,BeanValidationException.java,RFC3339DateFormat.java,ServerConfiguration.java,ServerVariable.java,StringUtil.java,Authentication.java,HttpBasicAuth.java,HttpBearerAuth.java,ApiKeyAuth.java,ApiException.java,Pair.java,ApiResponse.java,JavaTimeFormatter.java,RFC3339JavaTimeModule.java,Configuration.java,RFC3339InstantDeserializer.java,JSON.java,AbstractOpenApiSchema.java</boat-maven-plugin.supportingFilesToGenerate>
     </properties>
 
     <dependencies>

boat-maven-plugin/src/it/example/boat-generate/java-server/models/pom.xml

@@ -73,6 +73,11 @@
             <artifactId>swagger-annotations</artifactId>
             <version>2.2.7</version>
         </dependency>
+
+        <dependency>
+            <groupId>org.springframework</groupId>
+            <artifactId>spring-core</artifactId>
+        </dependency>
     </dependencies>
 
     <packaging>jar</packaging>

boat-maven-plugin/src/it/example/pom.xml

@@ -11,10 +11,10 @@
     <properties>
 
         <boat-maven-plugin.version>@pom.version@</boat-maven-plugin.version>
-<!--        <boat-maven-plugin.version>0.12.0-SNAPS§HOT</boat-maven-plugin.version>-->
-        <jackson-databind-nullable-version>0.2.3</jackson-databind-nullable-version>
+        <!--        <boat-maven-plugin.version>0.12.0-SNAPS§HOT</boat-maven-plugin.version>-->
+        <jackson-databind-nullable-version>0.2.9</jackson-databind-nullable-version>
 
-        <jackson.version>2.13.3</jackson.version>
+        <jackson.version>2.18.2</jackson.version>
         <jackson.version.annotations>${jackson.version}</jackson.version.annotations>
         <jackson.version.core>${jackson.version}</jackson.version.core>
         <jackson.version.databind>${jackson.version}</jackson.version.databind>
@@ -135,7 +135,7 @@
             <dependency>
                 <groupId>org.springframework.boot</groupId>
                 <artifactId>spring-boot-starter-webflux</artifactId>
-                <version>2.7.2</version>
+                <version>3.3.13</version>
             </dependency>
 
             <dependency>
@@ -147,13 +147,13 @@
             <dependency>
                 <groupId>org.springframework.boot</groupId>
                 <artifactId>spring-boot-starter-web</artifactId>
-                <version>2.7.2</version>
+                <version>3.3.13</version>
             </dependency>
 
             <dependency>
                 <groupId>org.springframework</groupId>
                 <artifactId>spring-core</artifactId>
-                <version>6.1.14</version>
+                <version>6.1.21</version>
                 <scope>compile</scope>
             </dependency>
 

boat-maven-plugin/src/main/java/com/backbase/oss/boat/AbstractGenerateMojo.java

@@ -8,6 +8,7 @@
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
+import org.openapitools.codegen.languages.SpringCodegen;
 
 @Slf4j
 public abstract class AbstractGenerateMojo extends GenerateMojo {
@@ -33,7 +34,6 @@ public void execute(String generatorName, String library, boolean isEmbedded, bo
         options.put("interfaceOnly", TRUE);
         options.put("useTags", TRUE);
         options.put("useBeanValidation", TRUE);
-        options.put("useClassLevelBeanValidation", FALSE);
         options.put("useOptional", FALSE);
         options.put("useJakartaEe", TRUE);
         options.put("useSpringBoot3", TRUE);
@@ -64,7 +64,21 @@ public void execute(String generatorName, String library, boolean isEmbedded, bo
         var merged = new HashMap<>();
         merged.putAll(defaultOptions);
         merged.putAll(overrides);
+        boolean sb3 = propertyToBool(merged.get(SpringCodegen.USE_SPRING_BOOT3));
+        boolean sb4 = propertyToBool(merged.get(SpringCodegen.USE_SPRING_BOOT4));
+        if (sb3 && sb4) {
+            merged.put(SpringCodegen.USE_SPRING_BOOT3, FALSE);
+        }
         return merged;
     }
+
+    private static boolean propertyToBool(Object value) {
+        if (value instanceof Boolean) {
+            return (Boolean) value;
+        } else if (value instanceof String) {
+            return Boolean.parseBoolean((String) value);
+        }
+        return false;
+    }
 }
 

boat-maven-plugin/src/main/java/com/backbase/oss/boat/GenerateMojo.java

@@ -15,7 +15,7 @@
 import static org.openapitools.codegen.config.CodegenConfiguratorUtils.applyLanguageSpecificPrimitivesCsv;
 import static org.openapitools.codegen.config.CodegenConfiguratorUtils.applyLanguageSpecificPrimitivesCsvList;
 import static org.openapitools.codegen.config.CodegenConfiguratorUtils.applyNameMappingsKvpList;
-import static org.openapitools.codegen.config.CodegenConfiguratorUtils.applyOpenAPINormalizerKvpList;
+import static org.openapitools.codegen.config.CodegenConfiguratorUtils.applyOpenapiNormalizerKvpList;
 import static org.openapitools.codegen.config.CodegenConfiguratorUtils.applyReservedWordsMappingsKvp;
 import static org.openapitools.codegen.config.CodegenConfiguratorUtils.applyReservedWordsMappingsKvpList;
 import static org.openapitools.codegen.config.CodegenConfiguratorUtils.applySchemaMappingsKvp;
@@ -880,7 +880,7 @@ public void execute() throws MojoExecutionException, MojoFailureException {
             }
 
             if (openapiNormalizer != null && (configOptions == null || !configOptions.containsKey("openapi-normalizer"))) {
-                applyOpenAPINormalizerKvpList(openapiNormalizer, configurator);
+                applyOpenapiNormalizerKvpList(openapiNormalizer, configurator);
             }
 
             // Apply Schema Mappings

boat-maven-plugin/src/main/java/com/backbase/oss/boat/GenerateRestTemplateEmbeddedMojo.java

@@ -20,6 +20,6 @@ public void execute() throws MojoExecutionException, MojoFailureException {
 
     @Override
     protected Collection<String> getGeneratorSpecificSupportingFiles() {
-        return Set.of("BigDecimalCustomSerializer.java");
+        return Set.of("BigDecimalCustomSerializer.java", "BaseApi.java");
     }
 }