feature(jackson3) add jackson3 support for spring generator

* add 'useJackson3' option
* add support for RestClient in spring-http-interfaces

See #22294

Author: Benjamin Einaudi

CONTRIBUTING.md

@@ -12,7 +12,7 @@
 
  - Search the [open issue](https://github.com/openapitools/openapi-generator/issues) to ensure no one else has reported something similar and no one is actively working on similar proposed change.
  - If no one has suggested something similar, open an ["issue"](https://github.com/openapitools/openapi-generator/issues) with your suggestion to gather feedback from the community.
- - If you're adding a new option to a generator, please consider using the `-t` option with customized templates instead or start a discussion first by opening an issue as we want to avoid adding too many options to the generator.
+ - If you're adding a new option to a generator, please consider using the `-t` option with customized templates instead or staonrt a discussi first by opening an issue as we want to avoid adding too many options to the generator.
  - It's recommended to **create a new git branch** for the change so that the merge commit message looks nicer in the commit history.
 
 ## How to contribute

bin/configs/spring-http-interface-noResponseEntity-jackson-3.yaml

@@ -0,0 +1,20 @@
+generatorName: spring
+library: spring-http-interface
+outputDir: samples/client/petstore/spring-http-interface-noResponseEntity-jackson-3
+inputSpec: modules/openapi-generator/src/test/resources/3_0/spring/petstore-with-fake-endpoints-models-for-testing.yaml
+templateDir: modules/openapi-generator/src/main/resources/JavaSpring
+additionalProperties:
+  artifactId: spring-http-interface-noResponseEntity-jackson-3
+  snapshotVersion: "true"
+  hideGenerationTimestamp: "true"
+  modelNameSuffix: 'Dto'
+  generatedConstructorWithRequiredArgs: "false"
+  # documentation provider should be ignored
+  documentationProvider: "springdoc"
+  # annotation provider should be ignored
+  annotationLibrary: "swagger2"
+  # validation should be ignored
+  useBeanValidation: "true"
+  performBeanValidation: "true"
+  useResponseEntity: "false"
+  useJackson3: "true"

docs/generators/java-camel.md

@@ -105,6 +105,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |useEnumCaseInsensitive|Use `equalsIgnoreCase` when String for enum comparison| |false|
 |useFeignClientContextId|Whether to generate Feign client with contextId parameter.| |true|
 |useFeignClientUrl|Whether to generate Feign client with url parameter.| |true|
+|useJackson3|Set it in order to use jackson 3 dependencies| |false|
 |useJakartaEe|whether to use Jakarta EE namespace instead of javax| |false|
 |useOneOfInterfaces|whether to use a java interface to describe a set of oneOf options, where each option is a class that implements the interface| |true|
 |useOptional|Use Optional container for optional parameters| |false|

docs/generators/spring.md

@@ -98,6 +98,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |useEnumCaseInsensitive|Use `equalsIgnoreCase` when String for enum comparison| |false|
 |useFeignClientContextId|Whether to generate Feign client with contextId parameter.| |true|
 |useFeignClientUrl|Whether to generate Feign client with url parameter.| |true|
+|useJackson3|Set it in order to use jackson 3 dependencies| |false|
 |useJakartaEe|whether to use Jakarta EE namespace instead of javax| |false|
 |useOneOfInterfaces|whether to use a java interface to describe a set of oneOf options, where each option is a class that implements the interface| |true|
 |useOptional|Use Optional container for optional parameters| |false|

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java

@@ -101,6 +101,7 @@ public class SpringCodegen extends AbstractJavaCodegen
     public static final String USE_SPRING_BUILT_IN_VALIDATION = "useSpringBuiltInValidation";
     public static final String USE_DEDUCTION_FOR_ONE_OF_INTERFACES = "useDeductionForOneOfInterfaces";
     public static final String SPRING_API_VERSION = "springApiVersion";
+    public static final String USE_JACKSON_3 = "useJackson3";
 
     @Getter
     public enum RequestMappingMode {
@@ -163,6 +164,8 @@ public enum RequestMappingMode {
     protected boolean useSpringBuiltInValidation = false;
     @Getter @Setter
     protected boolean useDeductionForOneOfInterfaces = false;
+    @Getter @Setter
+    protected boolean useJackson3 = false;
 
     public SpringCodegen() {
         super();
@@ -249,6 +252,7 @@ public SpringCodegen() {
         cliOptions
                 .add(CliOption.newBoolean(RETURN_SUCCESS_CODE, "Generated server returns 2xx code", returnSuccessCode));
         cliOptions.add(CliOption.newBoolean(SPRING_CONTROLLER, "Annotate the generated API as a Spring Controller", useSpringController));
+        cliOptions.add(CliOption.newBoolean(USE_JACKSON_3, "Set it in order to use jackson 3 dependencies", useJackson3));
 
         CliOption requestMappingOpt = new CliOption(REQUEST_MAPPING_OPTION,
                 "Where to generate the class level @RequestMapping annotation.")
@@ -472,6 +476,10 @@ public void processOpts() {
             applyJakartaPackage();
         }
         convertPropertyToStringAndWriteBack(RESOURCE_FOLDER, this::setResourceFolder);
+        convertPropertyToBooleanAndWriteBack(USE_JACKSON_3, this::setUseJackson3);
+
+        // override parent one
+        importMapping.put("JsonDeserialize", useJackson3 ? "tools.jackson.databind.annotation.JsonDeserialize" : "com.fasterxml.jackson.databind.annotation.JsonDeserialize");
 
         typeMapping.put("file", "org.springframework.core.io.Resource");
         importMapping.put("Nullable", "org.springframework.lang.Nullable");

modules/openapi-generator/src/main/resources/JavaSpring/homeController.mustache

@@ -4,7 +4,12 @@ import org.springframework.context.annotation.Bean;
 import org.springframework.stereotype.Controller;
 import org.springframework.web.bind.annotation.RequestMapping;
 {{#sourceDocumentationProvider}}
+{{#useJackson3}}
+import tools.jackson.dataformat.yaml.YAMLMapper;
+{{/useJackson3}}
+{{^useJackson3}}
 import com.fasterxml.jackson.dataformat.yaml.YAMLMapper;
+{{/useJackson3}}
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.core.io.Resource;
 import org.springframework.util.StreamUtils;

modules/openapi-generator/src/main/resources/JavaSpring/libraries/spring-boot/RFC3339DateFormat.mustache

@@ -1,6 +1,11 @@
 package {{basePackage}};
 
+{{#useJackson3}}
+import tools.jackson.databind.util.StdDateFormat;
+{{/useJackson3}}
+{{^useJackson3}}
 import com.fasterxml.jackson.databind.util.StdDateFormat;
+{{/useJackson3}}
 
 import java.text.DateFormat;
 import java.text.FieldPosition;

modules/openapi-generator/src/main/resources/JavaSpring/libraries/spring-boot/openapi2SpringBoot.mustache

@@ -1,7 +1,12 @@
 package {{basePackage}};
 
 {{#openApiNullable}}
+{{#useJackson3}}
+import tools.jackson.databind.JacksonModule;
+{{/useJackson3}}
+{{^useJackson3}}
 import com.fasterxml.jackson.databind.Module;
+{{/useJackson3}}
 import org.openapitools.jackson.nullable.JsonNullableModule;
 {{/openApiNullable}}
 import org.springframework.boot.SpringApplication;
@@ -26,7 +31,7 @@ public class OpenApiGeneratorApplication {
 
 {{#openApiNullable}}
     @Bean(name = "{{basePackage}}.OpenApiGeneratorApplication.jsonNullableModule")
-    public Module jsonNullableModule() {
+    public {{#useJackson3}}JacksonModule{{/useJackson3}}{{^useJackson3}}Module{{/useJackson3}} jsonNullableModule() {
         return new JsonNullableModule();
     }
 {{/openApiNullable}}

modules/openapi-generator/src/main/resources/JavaSpring/libraries/spring-boot/pom-sb3.mustache

@@ -180,7 +180,12 @@
             <version>3.0.2</version>
         </dependency>
         <dependency>
+        {{#useJackson3}}
+            <groupId>tools.jackson.dataformat</groupId>
+        {{/useJackson3}}
+        {{^useJackson3}}
             <groupId>com.fasterxml.jackson.dataformat</groupId>
+        {{/useJackson3}}
             <artifactId>jackson-dataformat-yaml</artifactId>
         </dependency>
         {{#withXml}}
@@ -190,17 +195,32 @@
           <artifactId>jakarta.xml.bind-api</artifactId>
         </dependency>
         <dependency>
+        {{#useJackson3}}
+            <groupId>tools.jackson.dataformat</groupId>
+        {{/useJackson3}}
+        {{^useJackson3}}
           <groupId>com.fasterxml.jackson.dataformat</groupId>
+        {{/useJackson3}}
           <artifactId>jackson-dataformat-xml</artifactId>
         </dependency>
         {{/withXml}}
         <dependency>
+        {{#useJackson3}}
+            <groupId>tools.jackson.datatype</groupId>
+        {{/useJackson3}}
+        {{^useJackson3}}
             <groupId>com.fasterxml.jackson.datatype</groupId>
+        {{/useJackson3}}
             <artifactId>jackson-datatype-jsr310</artifactId>
         </dependency>
         {{#joda}}
         <dependency>
+        {{#useJackson3}}
+            <groupId>tools.jackson.datatype</groupId>
+        {{/useJackson3}}
+        {{^useJackson3}}
             <groupId>com.fasterxml.jackson.datatype</groupId>
+        {{/useJackson3}}
             <artifactId>jackson-datatype-joda</artifactId>
         </dependency>
         {{/joda}}
@@ -247,7 +267,12 @@
         </dependency>
 {{/lombok}}
         <dependency>
+        {{#useJackson3}}
+            <groupId>tools.jackson.core</groupId>
+        {{/useJackson3}}
+        {{^useJackson3}}
             <groupId>com.fasterxml.jackson.core</groupId>
+        {{/useJackson3}}
             <artifactId>jackson-databind</artifactId>
         </dependency>
         <dependency>