jackson 3 support (#364)

Author: hauner

openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/converter/ApiOptions.kt

@@ -66,9 +66,9 @@ class ApiOptions: MappingSettings {
     var beanValidationFormat: String? = null
 
     /**
-     * Bean Validation format: com.fasterxml.jackson (v2) or tools.jackson (v3)
+     * jackson version: com.fasterxml.jackson (v2) or tools.jackson (v3)
      */
-    var jacksonFormat: String = "2"
+    var jackson: String = "v2"
 
     /**
      * enable/disable generation of Javadoc comments based on the `description` OpenAPI property.

openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/converter/OptionsConverter.kt

@@ -98,6 +98,7 @@ class OptionsConverter(private val checkObsoleteProcessorOptions: Boolean = fals
                         options.targetDirOptions.layout = TargetDirLayout.STANDARD
                     }
 
+                    options.jackson = mapping.options.jackson
                     options.javadoc = mapping.options.javadoc
                     options.oneOfInterface = mapping.options.oneOfInterface
                     options.responseInterface = mapping.options.responseInterface

openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/processor/MappingConverter.kt

@@ -11,7 +11,7 @@ import io.openapiprocessor.core.processor.mapping.v2.Mapping as MappingV2
 import io.openapiprocessor.core.processor.mapping.v2.MappingConverter as MappingConverterV2
 
 /**
- *  Converter for the type mapping from the mapping yaml. It converts the type mapping information
+ *  Converter for the type mapping from the mapping YAML. It converts the type mapping information
  *  into the format used by [io.openapiprocessor.core.converter.DataTypeConverter].
  */
 class MappingConverter {

openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/processor/mapping/v2/Options.kt

@@ -40,7 +40,12 @@ data class Options(
     val beanValidation: String = "false",
 
     /**
-     * generate javadoc (optional)
+     * jackson (optional)
+     */
+    val jackson: String = "v2",
+
+    /**
+     * generate Javadoc (optional)
      */
     val javadoc: Boolean = false,
 

openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/writer/java/JacksonAnnotations.kt

@@ -33,9 +33,9 @@ class JacksonAnnotations(apiOptions: ApiOptions) {
     fun getJsonValue(): Annotation = jsonValue
 
     private fun getJacksonFormat(options: ApiOptions): JacksonFormat {
-        return when (options.jacksonFormat) {
-            "2" -> JacksonFormat.V2
-            "3" -> JacksonFormat.V3
+        return when (options.jackson) {
+            "v2" -> JacksonFormat.V2
+            "v3" -> JacksonFormat.V3
             else -> JacksonFormat.V2
         }
     }

openapi-processor-core/src/main/resources/mapping/v18/mapping.example.yaml

@@ -0,0 +1,186 @@
+##
+## mapping example with keys and values
+##
+
+# mapping format (required)
+openapi-processor-mapping: v18
+
+options: # general processor options (required)
+
+  # the target package (required): io.openapiprocessor.generated (default)
+  # package-name: io.openapiprocessor.generated
+
+  # package-name related options
+  package-names:
+    # same as package-name
+    base: io.openapiprocessor.generated
+
+    # base package name of location-based generated files
+    location: io.openapiprocessor
+
+  # enable validation annotations (optional): true or false (default), javax, jakarta
+  bean-validation: jakarta
+
+  # jackson version (optional): 2 (default), 3
+  jackson: v2
+
+  # generate Javadoc from OpenAPI 'description' properties.
+  javadoc: true
+
+  # enable/disable code formatter: false (default), true (= google), google or eclipse
+  format-code: false
+
+  # add suffix for model class names and enum names. not set (default)
+  model-name-suffix: Resource
+
+  # create pojo (= default) (default) or record
+  model-type: default
+
+  # generate unreferenced model from components/schemas, true or false (default)
+  model-unreferenced: true
+
+  # default, string, supplier
+  enum-type: default
+
+  # generate common interface for an `oneOf` object list (optional): true or false (default)
+  one-of-interface: true
+
+  # generate a common interface for different response types of the same content-type
+  response-interface: true
+
+  # enable/disable deletion of targetDir: true (default) or false.
+  clear-target-dir: false
+
+  # enable/disable @Generated annotation
+  generated-annotation: true
+
+  # enable/disable date on @Generated annotation
+  generated-date: true
+
+  # control @JsonProperty annotation (always|auto|never)
+  json-property-annotation: always
+
+  # target-dir related configuration
+  target-dir:
+    clear: true
+    layout: standard
+
+  # server-url related configuration
+  base-path:
+    # false, true = 0, 1, etc.
+    prefix: 0
+    # property resource with the uri base path
+    properties-name: openapi.properties
+
+logging:
+  mapping: true
+  mapping-target: stdout
+
+compatibility:
+  bean-validation-valid-on-reactive: false
+  identifier-word-break-from-digit-to-letter: false
+
+bean-validation:
+  javax.validation.constraints.Size:
+    - org.openapitools.jackson.nullable.JsonNullable
+
+map: # the type mappings
+
+  # global mappings, applies to all paths/endpoints
+
+  # x-www-form-urlencoded as object ord destructured parameters
+  body-style: destructure
+
+  # response wrapper (optional)
+  result: org.springframework.http.ResponseEntity
+
+  # result style (optional, default "success")
+  result-style: all
+
+  # result status annotation (optional, default true)
+  result-status: true
+
+  # reactive single wrapper (optional)
+  single: reactor.core.publisher.Mono
+
+  # reactive array wrapper (optional)
+  multi: reactor.core.publisher.Flux
+
+  types: # global type mappings (optional)
+    - type: array => java.util.Collection
+
+    - type: Schema => java.util.Map
+      generics:
+        - java.lang.String
+        - java.lang.Double
+    - type: Schema =+ java.io.Serializable
+    - type: Schema @ io.openapiprocessor.Annotation()
+
+  schemas: # global schema mappings (optional)
+    - type: Schema @ io.openapiprocessor.Annotation()
+
+  parameters: # global parameter mappings (optional)
+    - name: foo => java.util.List
+    - name: bar => com.github.hauner.openapi.Bar
+    - name: param @ io.openapiprocessor.Annotation()
+    - type: Schema =+ java.io.Serializable
+    - type: Schema @ io.openapiprocessor.Annotation()
+
+  responses:  # global response mappings (optional)
+    - content: application/vnd.something => java.util.List
+    - content: application/json => com.github.hauner.openapi.FooBar
+
+  paths: # path/endpoint specific mappings (optional)
+
+    /first: # a path/endpoint from the openapi.yaml
+
+      # generate endpoint to a separate "excluded" interface
+      exclude: true
+
+    /second: # another path/endpoint from the openapi.yaml
+
+      # path mappings allow the same mappings as on the global level (except the "paths" property)
+      # all mappings apply only to the parent path overriding any matching global mapping
+
+      # override top level "result" property, "plain" means no wrapper
+      body-style: object
+      result: plain
+      single: reactor.core.publisher.Mono
+      multi: reactor.core.publisher.Flux
+
+      types:
+        - type: Schema => java.util.Collection
+        - type: Schema =+ java.io.Serializable
+
+      schemas:
+        - type: Schema @ io.openapiprocessor.Annotation()
+
+      parameters:
+        - name: foo => java.util.List
+        - add: bar => java.util.Set
+        - type: Schema =+ java.io.Serializable
+        - type: Schema @ io.openapiprocessor.Annotation()
+
+      responses:
+        - content: application/vnd.any => java.util.Set
+        - content: application/json => java.util.Map
+
+    /third:
+      result: plain
+
+      # path mappings can be limited to a specific http method
+
+      patch:
+        # path method mappings allow the same mappings as on the global level (except the "paths" property)
+        # all mappings apply only to the parent path and method overriding any matching global mapping
+
+        null: org.openapitools.jackson.nullable.JsonNullable = JsonNullable.undefined()
+
+  extensions:
+    x-something: foo @ some.Annotation
+    x-something-else:
+      - foo @ some.custom.FooAnnotation
+      - bar @ some.custom.BarAnnotation
+
+annotation-targets:
+  lombok.Builder: ['type', 'method']