Add --serialization-library option

cjbooms · Oct 17, 2024 · 2a3ee2b · 2a3ee2b
1 parent b95cb5b
commit 2a3ee2b
Show file tree

Hide file tree

Showing 5 changed files with 34 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -210,6 +210,10 @@ This section documents the available CLI parameters for controlling what gets ge
 |   `--http-model-suffix`       | Specify custom suffix for all generated model classes. Defaults to no suffix. |
 |   `--output-directory`        | Allows the generation dir to be overridden. Defaults to current dir |
 |   `--resources-path`          | Allows the path for generated resources to be overridden. Defaults to `src/main/resources` |
+|   `--serialization-library`   | Specify which serialization library to use for annotations in generated model classes. Default: JACKSON |
+|                               | CHOOSE ONE OF: |
+|                               |   `JACKSON` - Use Jackson for serialization and deserialization |
+|                               |   `KOTLINX_SERIALIZATION` - **!EXPERIMENTAL!** Use kotlinx.serialization for serialization and deserialization |
 |   `--src-path`                | Allows the path for generated source files to be overridden. Defaults to `src/main/kotlin` |
 |   `--targets`                 | Targets are the parts of the application that you want to be generated. |
 |                               | CHOOSE ANY OF: |

diff --git a/src/main/kotlin/com/cjbooms/fabrikt/cli/CodeGen.kt b/src/main/kotlin/com/cjbooms/fabrikt/cli/CodeGen.kt
@@ -35,7 +35,8 @@ object CodeGen {
             codeGenArgs.srcPath,
             codeGenArgs.resourcesPath,
             codeGenArgs.validationLibrary,
-            codeGenArgs.externalRefResolutionMode
+            codeGenArgs.externalRefResolutionMode,
+            codeGenArgs.serializationLibrary,
         )
     }
 
@@ -55,7 +56,8 @@ object CodeGen {
         srcPath: Path,
         resourcesPath: Path,
         validationLibrary: ValidationLibrary,
-        externalRefResolutionMode: ExternalReferencesResolutionMode
+        externalRefResolutionMode: ExternalReferencesResolutionMode,
+        serializationLibrary: SerializationLibrary,
     ) {
         MutableSettings.updateSettings(
             codeGenTypes,
@@ -68,7 +70,7 @@ object CodeGen {
             typeOverrides,
             validationLibrary,
             externalRefResolutionMode
-        )
+        , serializationLibrary)
 
         val suppliedApi = pathToApi.toFile().readText()
         val baseDir = pathToApi.parent

diff --git a/src/main/kotlin/com/cjbooms/fabrikt/cli/CodeGenArgs.kt b/src/main/kotlin/com/cjbooms/fabrikt/cli/CodeGenArgs.kt
@@ -153,6 +153,13 @@ class CodeGenArgs {
         converter = ExternalReferencesResolutionModeConverter::class
     )
     var externalRefResolutionMode: ExternalReferencesResolutionMode = ExternalReferencesResolutionMode.TARGETED
+
+    @Parameter(
+        names = ["--serialization-library"],
+        description = "Specify which serialization library to use for annotations in generated model classes. Default: JACKSON",
+        converter = SerializationLibraryOptionConverter::class
+    )
+    var serializationLibrary: SerializationLibrary = SerializationLibrary.JACKSON
 }
 
 class CodeGenerationTypesConverter : IStringConverter<CodeGenerationType> {
@@ -193,6 +200,10 @@ class ExternalReferencesResolutionModeConverter: IStringConverter<ExternalRefere
     override fun convert(value: String): ExternalReferencesResolutionMode = convertToEnumValue(value)
 }
 
+class SerializationLibraryOptionConverter : IStringConverter<SerializationLibrary> {
+    override fun convert(value: String): SerializationLibrary = convertToEnumValue(value)
+}
+
 class PackageNameValidator : IValueValidator<String> {
     override fun validate(name: String, value: String) {
         if (!value.isValidJavaPackage()) {

diff --git a/src/main/kotlin/com/cjbooms/fabrikt/cli/CodeGenOptions.kt b/src/main/kotlin/com/cjbooms/fabrikt/cli/CodeGenOptions.kt
@@ -4,6 +4,9 @@ import com.cjbooms.fabrikt.generators.JakartaAnnotations
 import com.cjbooms.fabrikt.generators.JavaxValidationAnnotations
 import com.cjbooms.fabrikt.generators.NoValidationAnnotations
 import com.cjbooms.fabrikt.generators.ValidationAnnotations
+import com.cjbooms.fabrikt.model.SerializationAnnotations
+import com.cjbooms.fabrikt.model.JacksonAnnotations
+import com.cjbooms.fabrikt.model.KotlinxSerializationAnnotations
 
 enum class CodeGenerationType(val description: String) {
     HTTP_MODELS(
@@ -86,3 +89,10 @@ enum class ExternalReferencesResolutionMode(val description: String) {
 
     override fun toString() = "`${super.toString()}` - $description"
 }
+
+enum class SerializationLibrary(val description: String, val serializationAnnotations: SerializationAnnotations) {
+    JACKSON("Use Jackson for serialization and deserialization", JacksonAnnotations),
+    KOTLINX_SERIALIZATION("**!EXPERIMENTAL!** Use kotlinx.serialization for serialization and deserialization", KotlinxSerializationAnnotations);
+
+    override fun toString() = "`${super.toString()}` - $description"
+}
diff --git a/src/main/kotlin/com/cjbooms/fabrikt/generators/MutableSettings.kt b/src/main/kotlin/com/cjbooms/fabrikt/generators/MutableSettings.kt
@@ -13,6 +13,7 @@ object MutableSettings {
     private lateinit var typeOverrides: MutableSet<CodeGenTypeOverride>
     private lateinit var validationLibrary: ValidationLibrary
     private lateinit var externalRefResolutionMode: ExternalReferencesResolutionMode
+    private lateinit var serializationLibrary: SerializationLibrary
 
     fun updateSettings(
         genTypes: Set<CodeGenerationType> = emptySet(),
@@ -25,6 +26,7 @@ object MutableSettings {
         typeOverrides: Set<CodeGenTypeOverride> = emptySet(),
         validationLibrary: ValidationLibrary = ValidationLibrary.JAVAX_VALIDATION,
         externalRefResolutionMode: ExternalReferencesResolutionMode = ExternalReferencesResolutionMode.TARGETED,
+        serializationLibrary: SerializationLibrary = SerializationLibrary.JACKSON,
     ) {
         this.generationTypes = genTypes.toMutableSet()
         this.controllerOptions = controllerOptions.toMutableSet()
@@ -36,6 +38,7 @@ object MutableSettings {
         this.typeOverrides = typeOverrides.toMutableSet()
         this.validationLibrary = validationLibrary
         this.externalRefResolutionMode = externalRefResolutionMode
+        this.serializationLibrary = serializationLibrary
     }
 
     fun addOption(option: ModelCodeGenOptionType) = modelOptions.add(option)
@@ -51,4 +54,5 @@ object MutableSettings {
     fun typeOverrides() = this.typeOverrides.toSet()
     fun validationLibrary() = this.validationLibrary
     fun externalRefResolutionMode() = this.externalRefResolutionMode
+    fun serializationLibrary() = this.serializationLibrary
 }