OpenAPITools / OpenAPITools/openapi-generator

[REQ] Add a way to split models into multiple folders based on a criteria such as (request or response)

Open
#21,696 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.

I think that would be really beneficial for a lot of generators since it is common to have a requests folder and a response folder or DTO folder. EG company conventions

Describe the solution you'd like

I already make a solution that involved mapping each modelName to a Type by recursively going through the paths.
then overriding the toModelImport to track each model and change the import. I also needed to update the modelFileName to contain the location of the folder (not modelFileFolder because that is static and can't be influenced by the file name)

there is also the issue of "Orphan" models that are part of requests and responses because they are referenced in a Model but aren t a request in of themselves. Which needed to be dealt with and they were put in a 3rd separate folder

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

No files or tests are named. Start by locating the modelName, toModelImport, modelFileName, and modelFileFolder handling described in the request, then define how request, response, and orphan models are classified. Done means generators can place models into criteria-based folders while keeping generated imports correct.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.