Skip to content
GitLab

Fix Retrofit template with Jackson for Kotlin (Fix #8147)

Open Administrator requested to merge github/fork/yonatankarp/fix_retrofit_generator_with_jackson into master

Created by: yonatankarp

This commit amends the ApiClient template for Retrofit. It fixes a bug where the Retrofit client uses Jackson as the serialization library.

Until now, the ApiClient could not be compiled when using the Jackson library (default in SpringBoot applications), as the constructor of the class had the following parameter:

private val serializerBuilder: Builder = Serializer.Builder,

You can see it more clearly here:

image

After the fix the outcome of this line would be:

private val serializerBuilder: ObjectMapper = Serializer.jacksonObjectMapper,

The configuration that was used for the test is as follows:

config = mapOf(
    "dateLibrary" to "java8",
    "interfaceOnly" to "true",
    "implicitHeaders" to "true",
    "hideGenerationTimestamp" to "true",
    "useTags" to "true",
    "documentationProvider" to "none",
    "serializationLibrary" to "jackson",
    "useCoroutines" to "true",
    "library" to "jvm-retrofit2"
)

The change done in the commit is to ensure that in the case of Jackson, the right property of the Serializer class is assigned

validation of this change was by running the generator and ensuring that code the generated code passed compilation.

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples: 
    ./mvnw clean package 
./bin/generate-samples.sh
./bin/utils/export_docs_generators.sh
    Commit all changed files. This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master. These must match the expectations made by your contribution. You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*. For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master (6.3.0) (minor release - breaking changes with fallbacks), 7.0.x (breaking changes without fallbacks)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.