OpenAPITools / OpenAPITools/openapi-generator

[REQ] Add support for disabling generation of @Component in Spring RestTemplate generator

Open
#9,642 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.

I've got a Spring Boot Maven project with @ComponentScan enabled combined with Cucumber for testing.

In Cucumber i have the need to wire some Cucumber test beans up (eg. ApiClient) with a specific scope >@Scope(SCOPE_CUCUMBER_GLUE)<.

And i need to be able to make OpenApi generator not generate the @Component annotation - as I need to define the ApiClient and Api as a @Bean manually to set the correct scope for testing.

Describe the solution you'd like

A generator property 'disableAutoWiring' or alike in maven plugin etc.

Describe alternatives you've considered

A workaround for now is to use my own mustace templates (api.mustace, ApiClient.mustace) - although not very convenient, when upgrading to new releases of openapi generator.

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 Spring RestTemplate generator and the api.mustace and ApiClient.mustace templates mentioned in the issue, then inspect how generator properties are exposed through the Maven plugin. Done means a configurable option suppresses generated @Component annotations without requiring custom templates, with coverage for the resulting output.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, spring, spring-boot
Domain
api, backend, tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.