OpenAPITools / OpenAPITools/openapi-generator

[REQ] Add deserializers in generated kotlin models

Open
#13,266 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Enhancement: Feature
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Is your feature request related to a problem? Please describe.

Deserializing JSON objects with Jackon, by default, uses reflection. All the information about how to deserialize an object is availbale in the OpenAPI spec. This leads to perfomance issues since reflection is a lot slower than explicitly compiled code. In projects that handle large amounts of JSON data this can become a significant bottleneck when processing.

Describe the solution you'd like

We propose to generate Deserializers when generating Kotlin data classes for a model when using the Jackson library. This allows parsing JSON objects using explicitly compiled code rather than relying on reflection. Experiments show that this achives an approximate 3x speedup of JSON parsing.

Describe alternatives you've considered

We looked at the Afterburner module in Jackson, but this does not utilize the information available in the OpenAPI spec and thus does not give the wanted performance boost.

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

The issue names no files, tests, or entry points. Start by locating Kotlin data-class generation and the Jackson library path; done would mean generated Kotlin models include compiled Jackson deserializers rather than relying on reflection, with the claimed parsing improvement verified.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, kotlin
Domain
api, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.