Skip to content

feat(java client): Generalize generateClientAsBean for webclient and restclient libraries (#19229) #19717

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

elvay1
Copy link

@elvay1 elvay1 commented Sep 30, 2024

Add usage of generateClientAsBean annotation in RestClient and Webclient templates and include it in documentation.

It leverages the same mechanisms as the resttemplate library template ie: add the following template before ApiClient class and all generated APIs classes

{{#generateClientAsBean}}
@Component("{{package}}.{{classname}}")
{{/generateClientAsBean}

@bbdouglas, @sreeshas, @jfiala, @lukoyanov, @cbornet, @jeff9finger, @karismann, @Zomzog, @lwlee2608, @martin-mfg

Fix #19229
Fix #17885

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package 
    ./bin/generate-samples.sh ./bin/configs/*.yaml
    ./bin/utils/export_docs_generators.sh
    
    (For Windows users, please run the script in Git BASH)
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

Add usage of generateClientAsBean annotation in RestClient and Webclient
templates and include it in documentation.

Issue: OpenAPITools#19229
@elvay1 elvay1 force-pushed the 19229-enableClientAsBean branch from 785088d to 0986b75 Compare October 1, 2024 05:34
@elvay1 elvay1 changed the title feat(java client): Generalize generateClientAsBean (#19229) feat(java client): Generalize generateClientAsBean for webclient and restclient libraries (#19229) Oct 1, 2024
@huberrom
Copy link

huberrom commented Oct 1, 2024

Would be really helpful for us as well

@martin-mfg
Copy link
Contributor

Hi @elvay1, thanks for the PR!

The PR which originally introduced generateClientAsBean for the resttemplate library (#15416) added @Autowired along with @Component. Would it make sense to do this here too?

Also, could you resolve the conflicts with the master branch please?

@wing328
Copy link
Member

wing328 commented Dec 30, 2024

@elvay1 thanks again for the PR

let us know if you need help resolving the merge conflicts

another way is to file a new PR based on the latest master

looking forward to incorporating your enhancements into the latest master

@wing328 wing328 added this to the 7.11.0 milestone Dec 30, 2024
@wing328 wing328 modified the milestones: 7.11.0, 7.12.0 Jan 20, 2025
@wing328 wing328 modified the milestones: 7.12.0, 7.13.0 Feb 28, 2025
@wing328 wing328 modified the milestones: 7.13.0, 7.14.0 Apr 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants