OpenAPITools / OpenAPITools/openapi-generator

[REQ] Allow authors of custom templates to apply multiple templates to api/model arrays

Open
#2,656 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.

Currently, users writing custom templates can only apply the templates supported by the built-in generator. If a generator doesn't support something like service interfaces or model test classes, the user can't specify these in their custom templates.

Describe the solution you'd like

Ideally, an extension to a configuration file to allow extending for a specific generator:

{
…
"modelTemplate": {
    "merge": false,
    "files": [
        { "template": "model.mustache", "extension": ".m"},
        { "template": "model_license.mustache", "extension": ".license"}
    ],
"apiTemplate": {
    "merge": false,
    "files": [
        { "template": "api.mustache", "extension": ".a"},
        { "template": "api_interface.mustache", "extension": ".ai"},
        { "template": "api_license.mustache", "extension": ".license"}
    ]
}
…
}

This doesn't address some things like output structures which would be required by generators.

Describe alternatives you've considered

n/a

Additional context

see #690

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 implementation files, tests, or entry points. Start by tracing how custom generator configuration selects modelTemplate and apiTemplate files, then review #690 for related context. Done means supporting multiple configured templates per generator while accounting for the output-structure limitations noted in the request.

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
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.