✨ Add support for shared/top-level parameters (dependencies, tags, etc) #2434
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
to handle defaults and overrides
…_router including: prefix, tags, dependencies, deprecated, include_in_schema, responses, default_response_class, callbacks
and showcase them in APIRouter, FastAPI, include_router
…o longer required
in top-level FastAPI, path operations, include_router, APIRouter, its path operations, nested include_router, nested APIRouter, and its path operations
Codecov Report
@@ Coverage Diff @@
## master #2434 +/- ##
==========================================
Coverage 100.00% 100.00%
==========================================
Files 240 242 +2
Lines 7101 7396 +295
==========================================
+ Hits 7101 7396 +295
Continue to review full report at Codecov.
|
|
🚀 Deployed on https://5fc3dabcda660a7d3c4aa06c--fastapi.netlify.app |
|
📝 Docs preview for commit 80dca8e at: https://5fc3d7036132441645f965c7--fastapi.netlify.app |
|
📝 Docs preview for commit b24d3b6 at: https://5fc3daed330a58d9eaac2e6f--fastapi.netlify.app |
7 tasks
This was referenced Nov 29, 2020
9 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions canno
2AE5
t be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
✨ Add support for shared/top-level parameters (dependencies, tags, etc) that can be set in
FastAPI,APIRouter, andinclude_router.Up to now, for several options, the only way to apply them to a group of path operations was in
include_router. That works well, but the call toapp.include_router()orrouter.include_router()is normally done in another file.That means that, for example, to apply authentication to all the path operations in a router it would end up being done in a different file, instead of keeping related logic together.
Setting options in
include_routerstill makes sense in some cases, for example, to override or increase configurations from a third party router included in an app. But in a router that is part of a bigger application, it would probably make more sense to add those settings when creating theAPIRouter.In
FastAPIThis allows setting the (mostly new) parameters (additionally to the already existing parameters):
default_response_class: updated to handle defaults inAPIRouterandinclude_router.dependencies: to include ✨ top-level dependencies ✨ that apply to the whole application. E.g. to add global authentication.callbacks: OpenAPI callbacks that apply to all the path operations.deprecated: to mark all the path operations as deprecated. 🤷include_in_schema: to allow excluding all the path operations from the OpenAPI schema.responses: OpenAPI responses that apply to all the path operations.For example:
In
APIRouterThis allows setting the (mostly new) parameters (additionally to the already existing parameters):
default_response_class: updated to handle defaults inAPIRouterandinclude_router. For example, it's not needed to set it explicitly when creating callbacks.dependencies: to include ✨ router-level dependencies ✨ that apply to all the path operations in a router. Up to now, this was only possible withinclude_router.callbacks: OpenAPI callbacks that apply to all the path operations in this router.deprecated: to mark all the path operations in a router as deprecated.include_in_schema: to allow excluding all the path operations in a router from the OpenAPI schema.responses: OpenAPI responses that apply to all the path operations in a router.prefix: to set the path prefix for a router. Up to now, this was only possible when callinginclude_router.tags: OpenAPI tags to apply to all the path operations in this router.For example:
In
include_routerThis allows setting the (mostly new) parameters (additionally to the already existing parameters):
default_response_class: updated to handle defaults inAPIRouterandFastAPI.deprecated: to mark all the path operations in a router as deprecated in OpenAPI.include_in_schema: to allow disabling all the path operations from showing in the OpenAPI schema.callbacks: OpenAPI callbacks that apply to all the path operations in this router.Note: all the previous parameters are still there, so it's still possible to declare
dependenciesininclude_router.Related to: #1053, #1054
This would supersede/include #1013