Skip to content

[Python][FastAPI] Added support for library mode #21080

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 5 commits into
base: master
Choose a base branch
from

Conversation

AdityaMayukhSom
Copy link

@AdityaMayukhSom AdityaMayukhSom commented Apr 12, 2025

This PR fixes #21079. This PR added one more config option isLibrary to FastAPI generator, which is defaulted to false to remain backwards compatible. In library mode, the docker and compose files are not generated and the security API functions use abstract base class to delegate security functionalities. On top of that, this PR also includes parent class ABC to all the base API classes in library mode to ensure all the implementing child classes must implement all the defined methods from the base class.

cc: @multani @fa0311 @krjakbrjak @tomplus @cbornet Can you please look into the PR and if everything is alright, merge this?

PR checklist

  • Read the contribution guidelines.
  • 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.
  • 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.
  • 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.

Sorry, something went wrong.

Verified

This commit was signed with the committer’s verified signature.
AdityaMayukhSom Aditya Mayukh Som

Verified

This commit was signed with the committer’s verified signature.
AdityaMayukhSom Aditya Mayukh Som

Verified

This commit was signed with the committer’s verified signature.
AdityaMayukhSom Aditya Mayukh Som

Verified

This commit was signed with the committer’s verified signature.
AdityaMayukhSom Aditya Mayukh Som
@AdityaMayukhSom
Copy link
Author

@wing328 Can you please review this PR?

@wing328
Copy link
Member

wing328 commented Apr 23, 2025

thanks for the PR

we need another samples to test the option

please clone ./bin/configs/python-fastapi.yaml to test the option. add the new samples to this PR

and update the workflow .github/workflows/samples-python-server.yaml accordingly

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
@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
Development

Successfully merging this pull request may close these issues.

[REQ] Python FastAPI Server Code Generator Library Mode
2 participants