Skip to content
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

[rust-axum] Split up api trait per tag #18621

Merged

Conversation

kalvinpearce
Copy link
Contributor

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

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

@wing328
Copy link
Member

wing328 commented May 9, 2024

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)

@kalvinpearce
Copy link
Contributor Author

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
Copy link
Contributor Author

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

@linxGnu
Copy link
Contributor

linxGnu commented May 10, 2024

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)

@kalvinpearce
Copy link
Contributor Author

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.

@wing328
Copy link
Member

wing328 commented May 14, 2024

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.

Copy link
Contributor

@linxGnu linxGnu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The output looks awesome to me! I just have some small comments, please fix them then LGTM @kalvinpearce

@kalvinpearce
Copy link
Contributor Author

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

@linxGnu
Copy link
Contributor

linxGnu commented May 17, 2024

LGTM. Kindly cc @wing328 for help to review.

@wing328 wing328 added this to the 7.6.0 milestone May 19, 2024
@wing328 wing328 merged commit e9f961e into OpenAPITools:master May 19, 2024
14 checks passed
@kalvinpearce kalvinpearce deleted the feat/rust-axum-trait-per-tag branch May 19, 2024 10:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[REQ] [Rust-Axum] Solution to split implementation across files
3 participants