openapi-generator icon indicating copy to clipboard operation
openapi-generator copied to clipboard

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

Open elvay1 opened this issue 1 year ago • 4 comments

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

  • [x] Read the contribution guidelines.
  • [x] 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.
  • [x] 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.
  • [x] 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)
  • [x] If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

elvay1 avatar Sep 30 '24 05:09 elvay1

Would be really helpful for us as well

huberrom avatar Oct 01 '24 15:10 huberrom

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?

martin-mfg avatar Oct 16 '24 22:10 martin-mfg

@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 avatar Dec 30 '24 07:12 wing328

Hello, is this going to be included in the 7.14 version ?

bhahn57570 avatar Jun 12 '25 11:06 bhahn57570

this PR is put on hold unless someone resolves the merge conflicts

wing328 avatar Aug 12 '25 02:08 wing328