jackson 3 support (#364)

hauner · hauner · commit f76b88b4c655 · 2026-03-04T23:49:57.000+01:00
diff --git a/openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/converter/ApiOptions.kt b/openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/converter/ApiOptions.kt
@@ -65,6 +65,11 @@ class ApiOptions: MappingSettings {
      */
     var beanValidationFormat: String? = null
 
+    /**
+     * Bean Validation format: com.fasterxml.jackson (v2) or tools.jackson (v3)
+     */
+    var jacksonFormat: String = "2"
+
     /**
      * enable/disable generation of Javadoc comments based on the `description` OpenAPI property.
      *
diff --git a/openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/writer/java/DataTypeWriterBase.kt b/openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/writer/java/DataTypeWriterBase.kt
@@ -43,7 +43,8 @@ abstract class DataTypeWriterBase(
     protected val apiOptions: ApiOptions,
     protected val identifier: Identifier,
     protected val generatedWriter: GeneratedWriter,
-    protected val validationAnnotations: BeanValidationFactory = BeanValidationFactory(apiOptions),
+    protected val validationAnnotations: BeanValidationFactory,
+    protected val jacksonAnnotations: JacksonAnnotations,
     protected val javadocFactory: JavaDocFactory
 ): DataTypeWriter {
     protected val annotationWriter = AnnotationWriter()
@@ -323,7 +324,7 @@ abstract class DataTypeWriterBase(
         val target = getTarget(propData.propDataType)
 
         if (requiresJsonPropertyAnnotation(propData)) {
-            imports.add("com.fasterxml.jackson.annotation.JsonProperty")
+            imports.addAll(jacksonAnnotations.getJsonProperty().imports)
         }
 
         if (apiOptions.beanValidation) {
diff --git a/openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/writer/java/DataTypeWriterPojo.kt b/openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/writer/java/DataTypeWriterPojo.kt
@@ -23,9 +23,16 @@ class DataTypeWriterPojo(
     identifier: Identifier,
     generatedWriter: GeneratedWriter,
     validationAnnotations: BeanValidationFactory = BeanValidationFactory(apiOptions),
+    jacksonAnnotations: JacksonAnnotations = JacksonAnnotations(apiOptions),
     javadocFactory: JavaDocFactory = JavaDocFactory(identifier)
-) : DataTypeWriterBase(apiOptions, identifier, generatedWriter, validationAnnotations, javadocFactory) {
-
+) : DataTypeWriterBase(
+    apiOptions,
+    identifier,
+    generatedWriter,
+    validationAnnotations,
+    jacksonAnnotations,
+    javadocFactory
+) {
     override fun write(target: Writer, dataType: ModelDataType) {
         val propsData = collectPropertiesData(dataType)
         writeFileHeader(target, dataType, propsData)
diff --git a/openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/writer/java/DataTypeWriterRecord.kt b/openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/writer/java/DataTypeWriterRecord.kt
@@ -20,9 +20,16 @@ class DataTypeWriterRecord(
     identifier: Identifier,
     generatedWriter: GeneratedWriter,
     validationAnnotations: BeanValidationFactory = BeanValidationFactory(apiOptions),
+    jacksonAnnotations: JacksonAnnotations = JacksonAnnotations(apiOptions),
     javadocFactory: JavaDocFactory = JavaDocFactory(identifier)
-) : DataTypeWriterBase(apiOptions, identifier, generatedWriter, validationAnnotations, javadocFactory) {
-
+) : DataTypeWriterBase(
+    apiOptions,
+    identifier,
+    generatedWriter,
+    validationAnnotations,
+    jacksonAnnotations,
+    javadocFactory
+) {
     override fun write(target: Writer, dataType: ModelDataType) {
         val propsData = collectPropertiesData(dataType)
         writeFileHeader(target, dataType, propsData)
diff --git a/openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/writer/java/Jackson.kt b/openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/writer/java/Jackson.kt
@@ -0,0 +1,11 @@
+/*
+ * Copyright 2026 https://github.com/openapi-processor/openapi-processor-base
+ * PDX-License-Identifier: Apache-2.0
+ */
+
+package io.openapiprocessor.core.writer.java
+
+enum class JacksonFormat(val pkg: String) {
+    V2("com.fasterxml.jackson"),
+    V3("tools.jackson")
+}
diff --git a/openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/writer/java/JacksonAnnotations.kt b/openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/writer/java/JacksonAnnotations.kt
@@ -0,0 +1,42 @@
+/*
+ * Copyright 2026 https://github.com/openapi-processor/openapi-processor-base
+ * PDX-License-Identifier: Apache-2.0
+ */
+
+package io.openapiprocessor.core.writer.java
+
+import io.openapiprocessor.core.converter.ApiOptions
+import io.openapiprocessor.core.model.Annotation
+
+class JacksonAnnotations(apiOptions: ApiOptions) {
+    private val jsonProperty: Annotation
+    private val jsonCreator: Annotation
+    private val jsonValue: Annotation
+
+    init {
+        when (getJacksonFormat(apiOptions)) {
+            JacksonFormat.V2 -> {
+                jsonProperty = Annotation("com.fasterxml.jackson.annotation.JsonProperty")
+                jsonCreator = Annotation("com.fasterxml.jackson.annotation.JsonCreator")
+                jsonValue = Annotation("com.fasterxml.jackson.annotation.JsonValue")
+            }
+            JacksonFormat.V3 -> {
+                jsonProperty = Annotation("tools.jackson.annotation.JsonProperty")
+                jsonCreator = Annotation("tools.jackson.annotation.JsonCreator")
+                jsonValue = Annotation("tools.jackson.annotation.JsonValue")
+            }
+        }
+    }
+
+    fun getJsonProperty(): Annotation = jsonProperty
+    fun getJsonCreator(): Annotation = jsonCreator
+    fun getJsonValue(): Annotation = jsonValue
+
+    private fun getJacksonFormat(options: ApiOptions): JacksonFormat {
+        return when (options.jacksonFormat) {
+            "2" -> JacksonFormat.V2
+            "3" -> JacksonFormat.V3
+            else -> JacksonFormat.V2
+        }
+    }
+}
diff --git a/openapi-processor-core/src/test/groovy/io/openapiprocessor/core/writer/java/DataTypeWriterSpec.groovy b/openapi-processor-core/src/test/groovy/io/openapiprocessor/core/writer/java/DataTypeWriterSpec.groovy
@@ -27,6 +27,7 @@ class DataTypeWriterSpec extends Specification {
         identifier,
         generatedWriter,
         new BeanValidationFactory(options),
+        new JacksonAnnotations(options),
         new JavaDocFactory(identifier))
     def target = new StringWriter ()
 
diff --git a/openapi-processor-core/src/test/kotlin/io/openapiprocessor/core/writer/java/DataTypeWriterPojoSpec.kt b/openapi-processor-core/src/test/kotlin/io/openapiprocessor/core/writer/java/DataTypeWriterPojoSpec.kt
@@ -11,6 +11,8 @@ import io.kotest.matchers.collections.shouldContain
 import io.kotest.matchers.equals.shouldBeEqual
 import io.kotest.matchers.shouldBe
 import io.kotest.matchers.string.shouldContain
+import io.mockk.mockk
+import io.mockk.verify
 import io.openapiprocessor.core.converter.ApiOptions
 import io.openapiprocessor.core.converter.JsonPropertyAnnotationMode
 import io.openapiprocessor.core.converter.mapping.*
@@ -862,4 +864,24 @@ class DataTypeWriterPojoSpec: StringSpec({
             |
             """.trimMargin()
     }
+
+    "looks up jackson annotations" {
+        val jackson = mockk<JacksonAnnotations>(relaxed = true)
+
+        val writer = DataTypeWriterPojo(
+            options,
+            identifier,
+            generatedWriter,
+            BeanValidationFactory(options),
+            jacksonAnnotations = jackson)
+
+        val dataType = ObjectDataType("Foo", "pkg", linkedMapOf(
+            Pair("foo", propertyDataTypeString())
+        ), DataTypeConstraints(required = listOf("foo")), false)
+
+        writer.write(target, dataType)
+
+        verify { jackson.getJsonProperty() }
+    }
+
 })
diff --git a/openapi-processor-core/src/test/kotlin/io/openapiprocessor/core/writer/java/DataTypeWriterRecordSpec.kt b/openapi-processor-core/src/test/kotlin/io/openapiprocessor/core/writer/java/DataTypeWriterRecordSpec.kt
@@ -14,6 +14,8 @@ import io.kotest.matchers.shouldBe
 import io.kotest.matchers.string.shouldContain
 import io.kotest.matchers.string.shouldNotContain
 import io.kotest.matchers.string.shouldStartWith
+import io.mockk.mockk
+import io.mockk.verify
 import io.openapiprocessor.core.converter.ApiOptions
 import io.openapiprocessor.core.converter.JsonPropertyAnnotationMode
 import io.openapiprocessor.core.converter.mapping.Annotation
@@ -568,5 +570,24 @@ class DataTypeWriterRecordSpec: StringSpec({
         val imports = extractImports(target)
         imports shouldNotContain "import some.Annotation;"
     }
+
+    "looks up jackson annotations" {
+        val jackson = mockk<JacksonAnnotations>(relaxed = true)
+
+        val writer = DataTypeWriterRecord(
+            options,
+            identifier,
+            generatedWriter,
+            BeanValidationFactory(options),
+            jacksonAnnotations = jackson)
+
+        val dataType = ObjectDataType("Foo", "pkg", linkedMapOf(
+            Pair("foo", propertyDataTypeString())
+        ), DataTypeConstraints(required = listOf("foo")), false)
+
+        writer.write(target, dataType)
+
+        verify { jackson.getJsonProperty() }
+    }
 })
 
diff --git a/openapi-processor-core/src/test/kotlin/io/openapiprocessor/core/writer/java/JacksonAnnotationsSpec.kt b/openapi-processor-core/src/test/kotlin/io/openapiprocessor/core/writer/java/JacksonAnnotationsSpec.kt
@@ -0,0 +1,35 @@
+/*
+ * Copyright 2026 https://github.com/openapi-processor/openapi-processor-base
+ * PDX-License-Identifier: Apache-2.0
+ */
+
+package io.openapiprocessor.core.writer.java
+
+import io.kotest.core.spec.style.StringSpec
+import io.kotest.matchers.collections.shouldContainExactly
+import io.openapiprocessor.core.converter.ApiOptions
+
+class JacksonAnnotationsSpec: StringSpec({
+
+    "provides jackson 2 annotations" {
+        val options = ApiOptions()
+        options.jacksonFormat = "2"
+
+        val jackson = JacksonAnnotations(options)
+
+        jackson.getJsonProperty().imports shouldContainExactly setOf("com.fasterxml.jackson.annotation.JsonProperty")
+        jackson.getJsonCreator().imports shouldContainExactly setOf("com.fasterxml.jackson.annotation.JsonCreator")
+        jackson.getJsonValue().imports shouldContainExactly setOf("com.fasterxml.jackson.annotation.JsonValue")
+    }
+
+    "provides jackson 3 annotations" {
+        val options = ApiOptions()
+        options.jacksonFormat = "3"
+
+        val jackson = JacksonAnnotations(options)
+
+        jackson.getJsonProperty().imports shouldContainExactly setOf("tools.jackson.annotation.JsonProperty")
+        jackson.getJsonCreator().imports shouldContainExactly setOf("tools.jackson.annotation.JsonCreator")
+        jackson.getJsonValue().imports shouldContainExactly setOf("tools.jackson.annotation.JsonValue")
+    }
+})
diff --git a/openapi-processor-core/src/testInt/kotlin/io/openapiprocessor/core/TestProcessor.kt b/openapi-processor-core/src/testInt/kotlin/io/openapiprocessor/core/TestProcessor.kt
@@ -52,6 +52,7 @@ class TestProcessor:
             val validationWriter = ValidationWriter(options, generatedWriter)
             val beanValidation = BeanValidationFactory(options)
             val javaDocFactory = JavaDocFactory(identifier)
+            val jacksonAnnotations = JacksonAnnotations(options)
             val formatter = getFormatter()
 
             val writer = ApiWriter(
@@ -80,13 +81,15 @@ class TestProcessor:
                         identifier,
                         generatedWriter,
                         beanValidation,
+                        jacksonAnnotations,
                         javaDocFactory
                     )
                     else -> DataTypeWriterPojo(
                         options,
                         identifier,
                         generatedWriter,
                         beanValidation,
+                        jacksonAnnotations,
                         javaDocFactory
                     )
                 },
