OpenAPITools / OpenAPITools/openapi-generator

[REQ] Substitute generated class by custom class extending this class

Open
#12,300 0 comments 1 reaction 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.

We would like to add some behaviors to the generated DTO, but we can't do it in the generated classes (new behaviors are class specific, so can't be global).

Describe the solution you'd like

A way to substitute a class by a custom from our project. Here is an example.

Generated class

package com.myapp.generated;

public class GeneratedClasseDTO {
 ...
}

Custom class (hand written) :

package com.myapp.custom;

import com.myapp.generated.GeneratedClasseDTO;

public class CustomGeneratedClasseDTO extends GeneratedClasseDTO  {
 ...
}

Another generated class

package com.myapp.generated;

public class AnotherGeneratedClasseDTO {

    // here the generation doesn't use directly the generated GeneratedClasseDTO class, but our custom class
    private CustomGeneratedClasseDTO generatedClasseDTO ;
}
<configuration>
    <substitutes>
        <substitute>
            <generated>com.myapp.generated.GeneratedClasseDTO</generated>
            <custom>com.myapp.custom.CustomGeneratedClasseDTO</custom>
        </substitute>
    </substitutes>

Describe alternatives you've considered

We use services/helpers, but we don't like it.

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 source files, tests, or entry points. Start by reviewing the requested XML substitution configuration and the generated Java DTO relationship; done means a configured custom subclass is used wherever the generated class would otherwise be referenced.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
devtools
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.