OpenAPITools / OpenAPITools/openapi-generator

[REQ] Controller interface naming

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

When generating server code with the maven plugin, the controller interface classe names are generated base on the name of the API endpoints from the first "/" until the second "/", if any.
I would like to be able to set custom names for the interface names.

Describe the solution you'd like

If I have 3 API endpints:
/car/paint
/car/wash
/moto
/truck/paint

This will generate 3 controller interfaces: CarApi, MotoApi, TruckApi.

I would like that all of the endpoint to be generated under the same controller interface, for example, MyAppApi.

Describe alternatives you've considered

I tried to look into the plugin configuration and I didn't find a way to do it.
One easy way how thi could be implemented is based on tags that we give to each API endpoint. In this case I would give to all the API endpoint the tag "MyApp".

Additional context

Nothing to add.

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

Start with the Maven plugin's server-code generation path and trace how controller interface names are derived from API endpoint paths. Check the plugin configuration and endpoint tag handling described in the issue. Done means a configurable naming approach can generate all listed endpoints under one interface such as MyAppApi.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api, backend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.