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

[rust-axum] Split up api trait per tag

Open kalvinpearce opened this issue 1 month ago • 8 comments

The rust-axum generator creates a single Api trait that holds all operations. This PR instead creates a trait for each tag. This allows for more flexibility in how the api is implemented as one can use the openapi normalizer to modify the tags.

cc @linxGnu

Fixes #18442.

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.1.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.

kalvinpearce avatar May 09 '24 04:05 kalvinpearce

please run ./bin/generate-samples.sh ./bin/configs/manual/rust-axum* to update the samples (use git bash or wsl if you're using windows)

wing328 avatar May 09 '24 04:05 wing328

Thanks for that, I had forgotten to run the rust specific samples and also caught an issue with one of the use statements, fixed in 7d6dbfc

kalvinpearce avatar May 09 '24 05:05 kalvinpearce

@linxGnu I have implemented your proposal of sorting and grouping traits to handle operations with multiple tags (see commit a896ed8)

I'm not sure where the best place to implement it would be, however I have got it working currently in addOperationToGroup. Please let me know if there is a more fitting place to implement it and I would be happy to move it there instead.

kalvinpearce avatar May 10 '24 05:05 kalvinpearce

Hi @kalvinpearce

Thank you so much for great PR. I need sometime to review it. Hopefully will feedback to you around 11:00am Tue next week (Japan time)

linxGnu avatar May 10 '24 06:05 linxGnu

No worries, please take your time. I am not a Java developer, nor have I looked too deeply into the inner workings of this codebase so please be as particular as you would like regarding code styling etc, I am happy to make any adjustments you recommend.

kalvinpearce avatar May 10 '24 07:05 kalvinpearce

This allows for more flexibility in how the api is implemented as one can use the openapi normalizer to modify the tags.

Totally agreed with this one. We can add more normalizer rules to cater more use cases if needed.

wing328 avatar May 14 '24 03:05 wing328

Thank you both for the feedback. @linxGnu I have implemented your comments in 01af1a8.

kalvinpearce avatar May 14 '24 11:05 kalvinpearce

LGTM. Kindly cc @wing328 for help to review.

linxGnu avatar May 17 '24 02:05 linxGnu