OpenAPITools / OpenAPITools/openapi-generator

[BUG] specifying jackson serialization in configOptions for java generation still uses gson

Open
#13,916 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Issue: Bug
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Bug Report Checklist
  • Have you provided a full/minimal spec to reproduce the issue?
  • Have you validated the input using an OpenAPI validator (example)?
  • Have you tested with the latest master to confirm the issue still exists?
  • Have you searched for related issues/PRs?
  • What's the actual output vs expected output?
  • [Optional] Sponsorship to speed up the bug fix or feature request (example)
Description

I would like to use jackson instead of gson for serialization when generating the java openapi client.
In configOptions in the generateJavaClient task, I have:

task generateJavaClient(type: org.openapitools.generator.gradle.plugin.tasks.GenerateTask) {
    group = 'OpenAPI Tools'
    description = 'Generates a Java SDK client to connect to this service'
    generatorName = "java"
    inputSpec = "$rootDir/open-api/alert-service-api-spec.yml".toString()
    outputDir = "$buildDir/generated/java".toString()
    apiPackage = "com.thousandeyes.alert.sdk.api"
    invokerPackage = "com.thousandeyes.alert.sdk.invoker"
    modelPackage = "com.thousandeyes.alert.sdk.model"
    configOptions = [
            library: "retrofit2",
            serializationLibrary: "jackson", // this does not seem to be honors. Still uses Gson.
            dateLibrary         : "java8"
    ]
}

openapi-generator version

I am using version 6.2.0. I don't know if it is a regression or not.

OpenAPI declaration file content or url

N/A

Generation Details

I got the same generated code (using gson serialization) whether serializationLibrary: "jackson" is specified or not.

Steps to reproduce

Run ./gradlew generateJavaClient

Related issues/PRs
Suggest a fix

Generated code should use jackson instead of gson.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by running ./gradlew generateJavaClient with the shown configOptions, then trace how the Java generator handles serializationLibrary for the retrofit2 library. Done means the generated client uses Jackson serialization instead of Gson when serializationLibrary is set to "jackson".

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api, tooling
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.