mirror
/
tiangolo.fastapi
mirror of https://github.com/tiangolo/fastapi
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

Merge remote-tracking branch 'origin/query_method' into query_method

pull/14408/head
Rauan 8 months ago
parent
1d327c7f55 5960ddebfa
commit
f5d77e5b4a
3 changed files with 366 additions and 368 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 364
      fastapi/applications.py
  2. 364
      fastapi/routing.py
  3. 6
      tests/test_http_query_method.py

364
fastapi/applications.py
View File

@ -4537,30 +4537,30 @@ class FastAPI(Starlette):
) )
def query( def query(
self, self,
path: Annotated[ path: Annotated[
str, str,
Doc( Doc(
""" """
The URL path to be used for this *path operation*. The URL path to be used for this *path operation*.
For example, in `http://example.com/items`, the path is `/items`. For example, in `http://example.com/items`, the path is `/items`.
""" """
), ),
], ],
*, *,
response_model: Annotated[ response_model: Annotated[
Any, Any,
Doc( Doc(
""" """
The type to use for the response. The type to use for the response.
It could be any valid Pydantic *field* type. So, it doesn't have to It could be any valid Pydantic *field* type. So, it doesn't have to
be a Pydantic model, it could be other things, like a `list`, `dict`, be a Pydantic model, it could be other things, like a `list`, `dict`,
etc. etc.
It will be used for: It will be used for:
* Documentation: the generated OpenAPI (and the UI at `/docs`) will * Documentation: the generated OpenAPI (and the UI at `/docs`) will
show it as the response (JSON Schema). show it as the response (JSON Schema).
* Serialization: you could return an arbitrary object and the * Serialization: you could return an arbitrary object and the
@ -4577,296 +4577,296 @@ class FastAPI(Starlette):
valid, that would mean a violation of the contract with the client, valid, that would mean a violation of the contract with the client,
so it's an error from the API developer. So, FastAPI will raise an so it's an error from the API developer. So, FastAPI will raise an
error and return a 500 error code (Internal Server Error). error and return a 500 error code (Internal Server Error).
Read more about it in the Read more about it in the
[FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/). [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).
""" """
), ),
] = Default(None), ] = Default(None),
status_code: Annotated[ status_code: Annotated[
Optional[int], Optional[int],
Doc( Doc(
""" """
The default status code to be used for the response. The default status code to be used for the response.
You could override the status code by returning a response directly. You could override the status code by returning a response directly.
Read more about it in the Read more about it in the
[FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/). [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).
""" """
), ),
] = None, ] = None,
tags: Annotated[ tags: Annotated[
Optional[List[Union[str, Enum]]], Optional[List[Union[str, Enum]]],
Doc( Doc(
""" """
A list of tags to be applied to the *path operation*. A list of tags to be applied to the *path operation*.
It will be added to the generated OpenAPI (e.g. visible at `/docs`). It will be added to the generated OpenAPI (e.g. visible at `/docs`).
Read more about it in the Read more about it in the
[FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags). [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).
""" """
), ),
] = None, ] = None,
dependencies: Annotated[ dependencies: Annotated[
Optional[Sequence[Depends]], Optional[Sequence[Depends]],
Doc( Doc(
""" """
A list of dependencies (using `Depends()`) to be applied to the A list of dependencies (using `Depends()`) to be applied to the
*path operation*. *path operation*.
Read more about it in the Read more about it in the
[FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/). [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).
""" """
), ),
] = None, ] = None,
summary: Annotated[ summary: Annotated[
Optional[str], Optional[str],
Doc( Doc(
""" """
A summary for the *path operation*. A summary for the *path operation*.
It will be added to the generated OpenAPI (e.g. visible at `/docs`). It will be added to the generated OpenAPI (e.g. visible at `/docs`).
Read more about it in the Read more about it in the
[FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/). [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).
""" """
), ),
] = None, ] = None,
description: Annotated[ description: Annotated[
Optional[str], Optional[str],
Doc( Doc(
""" """
A description for the *path operation*. A description for the *path operation*.
If not provided, it will be extracted automatically from the docstring If not provided, it will be extracted automatically from the docstring
of the *path operation function*. of the *path operation function*.
It can contain Markdown. It can contain Markdown.
It will be added to the generated OpenAPI (e.g. visible at `/docs`). It will be added to the generated OpenAPI (e.g. visible at `/docs`).
Read more about it in the Read more about it in the
[FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/). [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).
""" """
), ),
] = None, ] = None,
response_description: Annotated[ response_description: Annotated[
str, str,
Doc( Doc(
""" """
The description for the default response. The description for the default response.
It will be added to the generated OpenAPI (e.g. visible at `/docs`). It will be added to the generated OpenAPI (e.g. visible at `/docs`).
""" """
), ),
] = "Successful Response", ] = "Successful Response",
responses: Annotated[ responses: Annotated[
Optional[Dict[Union[int, str], Dict[str, Any]]], Optional[Dict[Union[int, str], Dict[str, Any]]],
Doc( Doc(
""" """
Additional responses that could be returned by this *path operation*. Additional responses that could be returned by this *path operation*.
It will be added to the generated OpenAPI (e.g. visible at `/docs`). It will be added to the generated OpenAPI (e.g. visible at `/docs`).
""" """
), ),
] = None, ] = None,
deprecated: Annotated[ deprecated: Annotated[
Optional[bool], Optional[bool],
Doc( Doc(
""" """
Mark this *path operation* as deprecated. Mark this *path operation* as deprecated.
It will be added to the generated OpenAPI (e.g. visible at `/docs`). It will be added to the generated OpenAPI (e.g. visible at `/docs`).
""" """
), ),
] = None, ] = None,
operation_id: Annotated[ operation_id: Annotated[
Optional[str], Optional[str],
Doc( Doc(
""" """
Custom operation ID to be used by this *path operation*. Custom operation ID to be used by this *path operation*.
By default, it is generated automatically. By default, it is generated automatically.
If you provide a custom operation ID, you need to make sure it is If you provide a custom operation ID, you need to make sure it is
unique for the whole API. unique for the whole API.
You can customize the You can customize the
operation ID generation with the parameter operation ID generation with the parameter
`generate_unique_id_function` in the `FastAPI` class. `generate_unique_id_function` in the `FastAPI` class.
Read more about it in the Read more about it in the
[FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function). [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).
""" """
), ),
] = None, ] = None,
response_model_include: Annotated[ response_model_include: Annotated[
Optional[IncEx], Optional[IncEx],
Doc( Doc(
""" """
Configuration passed to Pydantic to include only certain fields in the Configuration passed to Pydantic to include only certain fields in the
response data. response data.
Read more about it in the Read more about it in the
[FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude). [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).
""" """
), ),
] = None, ] = None,
response_model_exclude: Annotated[ response_model_exclude: Annotated[
Optional[IncEx], Optional[IncEx],
Doc( Doc(
""" """
Configuration passed to Pydantic to exclude certain fields in the Configuration passed to Pydantic to exclude certain fields in the
response data. response data.
Read more about it in the Read more about it in the
[FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude). [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).
""" """
), ),
] = None, ] = None,
response_model_by_alias: Annotated[ response_model_by_alias: Annotated[
bool, bool,
Doc( Doc(
""" """
Configuration passed to Pydantic to define if the response model Configuration passed to Pydantic to define if the response model
should be serialized by alias when an alias is used. should be serialized by alias when an alias is used.
Read more about it in the Read more about it in the
[FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude). [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).
""" """
), ),
] = True, ] = True,
response_model_exclude_unset: Annotated[ response_model_exclude_unset: Annotated[
bool, bool,
Doc( Doc(
""" """
Configuration passed to Pydantic to define if the response data Configuration passed to Pydantic to define if the response data
should have all the fields, including the ones that were not set and should have all the fields, including the ones that were not set and
have their default values. This is different from have their default values. This is different from
`response_model_exclude_defaults` in that if the fields are set, `response_model_exclude_defaults` in that if the fields are set,
they will be included in the response, even if the value is the same they will be included in the response, even if the value is the same
as the default. as the default.
When `True`, default values are omitted from the response. When `True`, default values are omitted from the response.
Read more about it in the Read more about it in the
[FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter). [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).
""" """
), ),
] = False, ] = False,
response_model_exclude_defaults: Annotated[ response_model_exclude_defaults: Annotated[
bool, bool,
Doc( Doc(
""" """
Configuration passed to Pydantic to define if the response data Configuration passed to Pydantic to define if the response data
should have all the fields, including the ones that have the same value should have all the fields, including the ones that have the same value
as the default. This is different from `response_model_exclude_unset` as the default. This is different from `response_model_exclude_unset`
in that if the fields are set but contain the same default values, in that if the fields are set but contain the same default values,
they will be excluded from the response. they will be excluded from the response.
When `True`, default values are omitted from the response. When `True`, default values are omitted from the response.
Read more about it in the Read more about it in the
[FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter). [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).
""" """
), ),
] = False, ] = False,
response_model_exclude_none: Annotated[ response_model_exclude_none: Annotated[
bool, bool,
Doc( Doc(
""" """
Configuration passed to Pydantic to define if the response data should Configuration passed to Pydantic to define if the response data should
exclude fields set to `None`. exclude fields set to `None`.
This is much simpler (less smart) than `response_model_exclude_unset` This is much simpler (less smart) than `response_model_exclude_unset`
and `response_model_exclude_defaults`. You probably want to use one of and `response_model_exclude_defaults`. You probably want to use one of
those two instead of this one, as those allow returning `None` values those two instead of this one, as those allow returning `None` values
when it makes sense. when it makes sense.
Read more about it in the Read more about it in the
[FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none). [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).
""" """
), ),
] = False, ] = False,
include_in_schema: Annotated[ include_in_schema: Annotated[
bool, bool,
Doc( Doc(
""" """
Include this *path operation* in the generated OpenAPI schema. Include this *path operation* in the generated OpenAPI schema.
This affects the generated OpenAPI (e.g. visible at `/docs`). This affects the generated OpenAPI (e.g. visible at `/docs`).
Read more about it in the Read more about it in the
[FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-parameters-from-openapi). [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-parameters-from-openapi).
""" """
), ),
] = True, ] = True,
response_class: Annotated[ response_class: Annotated[
Type[Response], Type[Response],
Doc( Doc(
""" """
Response class to be used for this *path operation*. Response class to be used for this *path operation*.
This will not be used if you return a response directly. This will not be used if you return a response directly.
Read more about it in the Read more about it in the
[FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse). [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).
""" """
), ),
] = Default(JSONResponse), ] = Default(JSONResponse),
name: Annotated[ name: Annotated[
Optional[str], Optional[str],
Doc( Doc(
""" """
Name for this *path operation*. Only used internally. Name for this *path operation*. Only used internally.
""" """
), ),
] = None, ] = None,
callbacks: Annotated[ callbacks: Annotated[
Optional[List[BaseRoute]], Optional[List[BaseRoute]],
Doc( Doc(
""" """
List of *path operations* that will be used as OpenAPI callbacks. List of *path operations* that will be used as OpenAPI callbacks.
This is only for OpenAPI documentation, the callbacks won't be used This is only for OpenAPI documentation, the callbacks won't be used
directly. directly.
It will be added to the generated OpenAPI (e.g. visible at `/docs`). It will be added to the generated OpenAPI (e.g. visible at `/docs`).
Read more about it in the Read more about it in the
[FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/). [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).
""" """
), ),
] = None, ] = None,
openapi_extra: Annotated[ openapi_extra: Annotated[
Optional[Dict[str, Any]], Optional[Dict[str, Any]],
Doc( Doc(
""" """
Extra metadata to be included in the OpenAPI schema for this *path Extra metadata to be included in the OpenAPI schema for this *path
operation*. operation*.
Read more about it in the Read more about it in the
[FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema). [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).
""" """
), ),
] = None, ] = None,
generate_unique_id_function: Annotated[ generate_unique_id_function: Annotated[
Callable[[routing.APIRoute], str], Callable[[routing.APIRoute], str],
Doc( Doc(
""" """
Customize the function used to generate unique IDs for the *path Customize the function used to generate unique IDs for the *path
operations* shown in the generated OpenAPI. operations* shown in the generated OpenAPI.
This is particularly useful when automatically generating clients or This is particularly useful when automatically generating clients or
SDKs for your API. SDKs for your API.
Read more about it in the Read more about it in the
[FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function). [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).
""" """
), ),
] = Default(generate_unique_id), ] = Default(generate_unique_id),
) -> Callable[[DecoratedCallable], DecoratedCallable]: ) -> Callable[[DecoratedCallable], DecoratedCallable]:
""" """
Add a *path operation* using an HTTP QUERY operation. Add a *path operation* using an HTTP QUERY operation.

364
fastapi/routing.py
View File

@ -4489,30 +4489,30 @@ class APIRouter(routing.Router):
) )
def query( def query(
self, self,
path: Annotated[ path: Annotated[
str, str,
Doc( Doc(
""" """
The URL path to be used for this *path operation*. The URL path to be used for this *path operation*.
For example, in `http://example.com/items`, the path is `/items`. For example, in `http://example.com/items`, the path is `/items`.
""" """
), ),
], ],
*, *,
response_model: Annotated[ response_model: Annotated[
Any, Any,
Doc( Doc(
""" """
The type to use for the response. The type to use for the response.
It could be any valid Pydantic *field* type. So, it doesn't have to It could be any valid Pydantic *field* type. So, it doesn't have to
be a Pydantic model, it could be other things, like a `list`, `dict`, be a Pydantic model, it could be other things, like a `list`, `dict`,
etc. etc.
It will be used for: It will be used for:
* Documentation: the generated OpenAPI (and the UI at `/docs`) will * Documentation: the generated OpenAPI (and the UI at `/docs`) will
show it as the response (JSON Schema). show it as the response (JSON Schema).
* Serialization: you could return an arbitrary object and the * Serialization: you could return an arbitrary object and the
@ -4529,296 +4529,296 @@ class APIRouter(routing.Router):
valid, that would mean a violation of the contract with the client, valid, that would mean a violation of the contract with the client,
so it's an error from the API developer. So, FastAPI will raise an so it's an error from the API developer. So, FastAPI will raise an
error and return a 500 error code (Internal Server Error). error and return a 500 error code (Internal Server Error).
Read more about it in the Read more about it in the
[FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/). [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).
""" """
), ),
] = Default(None), ] = Default(None),
status_code: Annotated[ status_code: Annotated[
Optional[int], Optional[int],
Doc( Doc(
""" """
The default status code to be used for the response. The default status code to be used for the response.
You could override the status code by returning a response directly. You could override the status code by returning a response directly.
Read more about it in the Read more about it in the
[FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/). [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).
""" """
), ),
] = None, ] = None,
tags: Annotated[ tags: Annotated[
Optional[List[Union[str, Enum]]], Optional[List[Union[str, Enum]]],
Doc( Doc(
""" """
A list of tags to be applied to the *path operation*. A list of tags to be applied to the *path operation*.
It will be added to the generated OpenAPI (e.g. visible at `/docs`). It will be added to the generated OpenAPI (e.g. visible at `/docs`).
Read more about it in the Read more about it in the
[FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags). [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).
""" """
), ),
] = None, ] = None,
dependencies: Annotated[ dependencies: Annotated[
Optional[Sequence[params.Depends]], Optional[Sequence[params.Depends]],
Doc( Doc(
""" """
A list of dependencies (using `Depends()`) to be applied to the A list of dependencies (using `Depends()`) to be applied to the
*path operation*. *path operation*.
Read more about it in the Read more about it in the
[FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/). [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).
""" """
), ),
] = None, ] = None,
summary: Annotated[ summary: Annotated[
Optional[str], Optional[str],
Doc( Doc(
""" """
A summary for the *path operation*. A summary for the *path operation*.
It will be added to the generated OpenAPI (e.g. visible at `/docs`). It will be added to the generated OpenAPI (e.g. visible at `/docs`).
Read more about it in the Read more about it in the
[FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/). [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).
""" """
), ),
] = None, ] = None,
description: Annotated[ description: Annotated[
Optional[str], Optional[str],
Doc( Doc(
""" """
A description for the *path operation*. A description for the *path operation*.
If not provided, it will be extracted automatically from the docstring If not provided, it will be extracted automatically from the docstring
of the *path operation function*. of the *path operation function*.
It can contain Markdown. It can contain Markdown.
It will be added to the generated OpenAPI (e.g. visible at `/docs`). It will be added to the generated OpenAPI (e.g. visible at `/docs`).
Read more about it in the Read more about it in the
[FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/). [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).
""" """
), ),
] = None, ] = None,
response_description: Annotated[ response_description: Annotated[
str, str,
Doc( Doc(
""" """
The description for the default response. The description for the default response.
It will be added to the generated OpenAPI (e.g. visible at `/docs`). It will be added to the generated OpenAPI (e.g. visible at `/docs`).
""" """
), ),
] = "Successful Response", ] = "Successful Response",
responses: Annotated[ responses: Annotated[
Optional[Dict[Union[int, str], Dict[str, Any]]], Optional[Dict[Union[int, str], Dict[str, Any]]],
Doc( Doc(
""" """
Additional responses that could be returned by this *path operation*. Additional responses that could be returned by this *path operation*.
It will be added to the generated OpenAPI (e.g. visible at `/docs`). It will be added to the generated OpenAPI (e.g. visible at `/docs`).
""" """
), ),
] = None, ] = None,
deprecated: Annotated[ deprecated: Annotated[
Optional[bool], Optional[bool],
Doc( Doc(
""" """
Mark this *path operation* as deprecated. Mark this *path operation* as deprecated.
It will be added to the generated OpenAPI (e.g. visible at `/docs`). It will be added to the generated OpenAPI (e.g. visible at `/docs`).
""" """
), ),
] = None, ] = None,
operation_id: Annotated[ operation_id: Annotated[
Optional[str], Optional[str],
Doc( Doc(
""" """
Custom operation ID to be used by this *path operation*. Custom operation ID to be used by this *path operation*.
By default, it is generated automatically. By default, it is generated automatically.
If you provide a custom operation ID, you need to make sure it is If you provide a custom operation ID, you need to make sure it is
unique for the whole API. unique for the whole API.
You can customize the You can customize the
operation ID generation with the parameter operation ID generation with the parameter
`generate_unique_id_function` in the `FastAPI` class. `generate_unique_id_function` in the `FastAPI` class.
Read more about it in the Read more about it in the
[FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function). [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).
""" """
), ),
] = None, ] = None,
response_model_include: Annotated[ response_model_include: Annotated[
Optional[IncEx], Optional[IncEx],
Doc( Doc(
""" """
Configuration passed to Pydantic to include only certain fields in the Configuration passed to Pydantic to include only certain fields in the
response data. response data.
Read more about it in the Read more about it in the
[FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude). [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).
""" """
), ),
] = None, ] = None,
response_model_exclude: Annotated[ response_model_exclude: Annotated[
Optional[IncEx], Optional[IncEx],
Doc( Doc(
""" """
Configuration passed to Pydantic to exclude certain fields in the Configuration passed to Pydantic to exclude certain fields in the
response data. response data.
Read more about it in the Read more about it in the
[FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude). [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).
""" """
), ),
] = None, ] = None,
response_model_by_alias: Annotated[ response_model_by_alias: Annotated[
bool, bool,
Doc( Doc(
""" """
Configuration passed to Pydantic to define if the response model Configuration passed to Pydantic to define if the response model
should be serialized by alias when an alias is used. should be serialized by alias when an alias is used.
Read more about it in the Read more about it in the
[FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude). [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).
""" """
), ),
] = True, ] = True,
response_model_exclude_unset: Annotated[ response_model_exclude_unset: Annotated[
bool, bool,
Doc( Doc(
""" """
Configuration passed to Pydantic to define if the response data Configuration passed to Pydantic to define if the response data
should have all the fields, including the ones that were not set and should have all the fields, including the ones that were not set and
have their default values. This is different from have their default values. This is different from
`response_model_exclude_defaults` in that if the fields are set, `response_model_exclude_defaults` in that if the fields are set,
they will be included in the response, even if the value is the same they will be included in the response, even if the value is the same
as the default. as the default.
When `True`, default values are omitted from the response. When `True`, default values are omitted from the response.
Read more about it in the Read more about it in the
[FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter). [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).
""" """
), ),
] = False, ] = False,
response_model_exclude_defaults: Annotated[ response_model_exclude_defaults: Annotated[
bool, bool,
Doc( Doc(
""" """
Configuration passed to Pydantic to define if the response data Configuration passed to Pydantic to define if the response data
should have all the fields, including the ones that have the same value should have all the fields, including the ones that have the same value
as the default. This is different from `response_model_exclude_unset` as the default. This is different from `response_model_exclude_unset`
in that if the fields are set but contain the same default values, in that if the fields are set but contain the same default values,
they will be excluded from the response. they will be excluded from the response.
When `True`, default values are omitted from the response. When `True`, default values are omitted from the response.
Read more about it in the Read more about it in the
[FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter). [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).
""" """
), ),
] = False, ] = False,
response_model_exclude_none: Annotated[ response_model_exclude_none: Annotated[
bool, bool,
Doc( Doc(
""" """
Configuration passed to Pydantic to define if the response data should Configuration passed to Pydantic to define if the response data should
exclude fields set to `None`. exclude fields set to `None`.
This is much simpler (less smart) than `response_model_exclude_unset` This is much simpler (less smart) than `response_model_exclude_unset`
and `response_model_exclude_defaults`. You probably want to use one of and `response_model_exclude_defaults`. You probably want to use one of
those two instead of this one, as those allow returning `None` values those two instead of this one, as those allow returning `None` values
when it makes sense. when it makes sense.
Read more about it in the Read more about it in the
[FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none). [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).
""" """
), ),
] = False, ] = False,
include_in_schema: Annotated[ include_in_schema: Annotated[
bool, bool,
Doc( Doc(
""" """
Include this *path operation* in the generated OpenAPI schema. Include this *path operation* in the generated OpenAPI schema.
This affects the generated OpenAPI (e.g. visible at `/docs`). This affects the generated OpenAPI (e.g. visible at `/docs`).
Read more about it in the Read more about it in the
[FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-parameters-from-openapi). [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-parameters-from-openapi).
""" """
), ),
] = True, ] = True,
response_class: Annotated[ response_class: Annotated[
Type[Response], Type[Response],
Doc( Doc(
""" """
Response class to be used for this *path operation*. Response class to be used for this *path operation*.
This will not be used if you return a response directly. This will not be used if you return a response directly.
Read more about it in the Read more about it in the
[FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse). [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).
""" """
), ),
] = Default(JSONResponse), ] = Default(JSONResponse),
name: Annotated[ name: Annotated[
Optional[str], Optional[str],
Doc( Doc(
""" """
Name for this *path operation*. Only used internally. Name for this *path operation*. Only used internally.
""" """
), ),
] = None, ] = None,
callbacks: Annotated[ callbacks: Annotated[
Optional[List[BaseRoute]], Optional[List[BaseRoute]],
Doc( Doc(
""" """
List of *path operations* that will be used as OpenAPI callbacks. List of *path operations* that will be used as OpenAPI callbacks.
This is only for OpenAPI documentation, the callbacks won't be used This is only for OpenAPI documentation, the callbacks won't be used
directly. directly.
It will be added to the generated OpenAPI (e.g. visible at `/docs`). It will be added to the generated OpenAPI (e.g. visible at `/docs`).
Read more about it in the Read more about it in the
[FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/). [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).
""" """
), ),
] = None, ] = None,
openapi_extra: Annotated[ openapi_extra: Annotated[
Optional[Dict[str, Any]], Optional[Dict[str, Any]],
Doc( Doc(
""" """
Extra metadata to be included in the OpenAPI schema for this *path Extra metadata to be included in the OpenAPI schema for this *path
operation*. operation*.
Read more about it in the Read more about it in the
[FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema). [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).
""" """
), ),
] = None, ] = None,
generate_unique_id_function: Annotated[ generate_unique_id_function: Annotated[
Callable[[APIRoute], str], Callable[[APIRoute], str],
Doc( Doc(
""" """
Customize the function used to generate unique IDs for the *path Customize the function used to generate unique IDs for the *path
operations* shown in the generated OpenAPI. operations* shown in the generated OpenAPI.
This is particularly useful when automatically generating clients or This is particularly useful when automatically generating clients or
SDKs for your API. SDKs for your API.
Read more about it in the Read more about it in the
[FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function). [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).
""" """
), ),
] = Default(generate_unique_id), ] = Default(generate_unique_id),
) -> Callable[[DecoratedCallable], DecoratedCallable]: ) -> Callable[[DecoratedCallable], DecoratedCallable]:
""" """
Add a *path operation* using an HTTP QUERY operation. Add a *path operation* using an HTTP QUERY operation.

6
tests/test_http_query_method.py
View File

@ -37,9 +37,7 @@ client = TestClient(app)
def test_query_item(): def test_query_item():
response = client.request( response = client.request("QUERY", "/items/", json={"name": "Foo", "price": 50.5})
"QUERY", "/items/", json={"name": "Foo", "price": 50.5}
)
assert response.status_code == 200 assert response.status_code == 200
assert response.json() == { assert response.json() == {
"name": "Foo", "name": "Foo",
@ -285,4 +283,4 @@ def test_openapi_schema():
}, },
} }
}, },
} }

Write Preview
Loading…
Cancel
Save