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

[Spring]Added support for composed annotations (@GetMapping,@PostMapping,@PutMapping,@DeleteMapping).

Open dRbAndrade opened this issue 10 months ago • 2 comments

I have noticed that when using the Spring generator, the API interface file would contain @RequestMapping(method = RequestMethod.<METHOD>) annotation. This would isn't exactly an issue but would be a code smell under sonar coding rule java:s4488 https://sonarsource.github.io/rspec/#/rspec/S4488. I tried to search for an existing way to change it but could not find it. So I went ahead and added the support myself.

This is a change for Java Spring generator so I'm tagging the committee: @cachescrubber @welshm @MelleD @atextor @manedev79 @javisst @borsch @banlevente @Zomzog @martin-mfg

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 || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (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.

dRbAndrade avatar Apr 22 '25 09:04 dRbAndrade

Hi @dRbAndrade, thanks for the PR!

Could you please take care of the review comments below and also add your new lambda to this section in the docs:

https://github.com/OpenAPITools/openapi-generator/blob/4cffd32f87224e54a60813e1fc9da73788977e54/docs/templating.md?plain=1#L817

Hello, @martin-mfg ! Sorry for the delay on the reply. Been busy.

I have updated with the requested changes, but I would advise against addting my lambda to the templating.md file because I can see all other lambdas are general purpose and can pretty much be used everywhere. Mine is very specific and has really no other use othe than this and should not be used by anyone else.

dRbAndrade avatar May 16 '25 17:05 dRbAndrade

I have updated with the requested changes, but I would advise against addting my lambda to the templating.md file because I can see all other lambdas are general purpose and can pretty much be used everywhere. Mine is very specific and has really no other use othe than this and should not be used by anyone else.

Good point, I agree. Since the new lambda is not general purpose, I guess it should not be created in DefaultCodegen but instead in SpringCodegen. Like this.

Also, please run ./bin/utils/export_docs_generators.sh to update the documentation.

Hey! @martin-mfg ! How you've been? So I updated the code and moved the lambda to the SpringCodegen class and ran the shell. But it generated LOTS of differences due to us setting the default behavior to true and I was not sure what to do so I just added them to the commit too. I think this was expected, I guess.

dRbAndrade avatar Jun 01 '25 10:06 dRbAndrade