diff --git a/fastapi/applications.py b/fastapi/applications.py index 6eed22db6..3c6530e95 100644 --- a/fastapi/applications.py +++ b/fastapi/applications.py @@ -4537,30 +4537,30 @@ class FastAPI(Starlette): ) def query( - self, - path: Annotated[ - str, - Doc( - """ + self, + path: Annotated[ + str, + Doc( + """ The URL path to be used for this *path operation*. - + For example, in `http://example.com/items`, the path is `/items`. """ - ), - ], - *, - response_model: Annotated[ - Any, - Doc( - """ + ), + ], + *, + response_model: Annotated[ + Any, + Doc( + """ The type to use for the response. - + 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`, etc. - + It will be used for: - + * Documentation: the generated OpenAPI (and the UI at `/docs`) will show it as the response (JSON Schema). * 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, so it's an error from the API developer. So, FastAPI will raise an error and return a 500 error code (Internal Server Error). - + Read more about it in the [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/). """ - ), - ] = Default(None), - status_code: Annotated[ - Optional[int], - Doc( - """ + ), + ] = Default(None), + status_code: Annotated[ + Optional[int], + Doc( + """ The default status code to be used for the response. - + You could override the status code by returning a response directly. - + Read more about it in the [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/). """ - ), - ] = None, - tags: Annotated[ - Optional[List[Union[str, Enum]]], - Doc( - """ + ), + ] = None, + tags: Annotated[ + Optional[List[Union[str, Enum]]], + Doc( + """ A list of tags to be applied to the *path operation*. - + It will be added to the generated OpenAPI (e.g. visible at `/docs`). - + Read more about it in the [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags). """ - ), - ] = None, - dependencies: Annotated[ - Optional[Sequence[Depends]], - Doc( - """ + ), + ] = None, + dependencies: Annotated[ + Optional[Sequence[Depends]], + Doc( + """ A list of dependencies (using `Depends()`) to be applied to the *path operation*. - + 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/). """ - ), - ] = None, - summary: Annotated[ - Optional[str], - Doc( - """ + ), + ] = None, + summary: Annotated[ + Optional[str], + Doc( + """ A summary for the *path operation*. - + It will be added to the generated OpenAPI (e.g. visible at `/docs`). - + Read more about it in the [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/). """ - ), - ] = None, - description: Annotated[ - Optional[str], - Doc( - """ + ), + ] = None, + description: Annotated[ + Optional[str], + Doc( + """ A description for the *path operation*. - + If not provided, it will be extracted automatically from the docstring of the *path operation function*. - + It can contain Markdown. - + It will be added to the generated OpenAPI (e.g. visible at `/docs`). - + Read more about it in the [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/). """ - ), - ] = None, - response_description: Annotated[ - str, - Doc( - """ + ), + ] = None, + response_description: Annotated[ + str, + Doc( + """ The description for the default response. - + It will be added to the generated OpenAPI (e.g. visible at `/docs`). """ - ), - ] = "Successful Response", - responses: Annotated[ - Optional[Dict[Union[int, str], Dict[str, Any]]], - Doc( - """ + ), + ] = "Successful Response", + responses: Annotated[ + Optional[Dict[Union[int, str], Dict[str, Any]]], + Doc( + """ Additional responses that could be returned by this *path operation*. - + It will be added to the generated OpenAPI (e.g. visible at `/docs`). """ - ), - ] = None, - deprecated: Annotated[ - Optional[bool], - Doc( - """ + ), + ] = None, + deprecated: Annotated[ + Optional[bool], + Doc( + """ Mark this *path operation* as deprecated. - + It will be added to the generated OpenAPI (e.g. visible at `/docs`). """ - ), - ] = None, - operation_id: Annotated[ - Optional[str], - Doc( - """ + ), + ] = None, + operation_id: Annotated[ + Optional[str], + Doc( + """ Custom operation ID to be used by this *path operation*. - + By default, it is generated automatically. - + If you provide a custom operation ID, you need to make sure it is unique for the whole API. - + You can customize the operation ID generation with the parameter `generate_unique_id_function` in the `FastAPI` class. - + 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). """ - ), - ] = None, - response_model_include: Annotated[ - Optional[IncEx], - Doc( - """ + ), + ] = None, + response_model_include: Annotated[ + Optional[IncEx], + Doc( + """ Configuration passed to Pydantic to include only certain fields in the response data. - + 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). """ - ), - ] = None, - response_model_exclude: Annotated[ - Optional[IncEx], - Doc( - """ + ), + ] = None, + response_model_exclude: Annotated[ + Optional[IncEx], + Doc( + """ Configuration passed to Pydantic to exclude certain fields in the response data. - + 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). """ - ), - ] = None, - response_model_by_alias: Annotated[ - bool, - Doc( - """ + ), + ] = None, + response_model_by_alias: Annotated[ + bool, + Doc( + """ Configuration passed to Pydantic to define if the response model should be serialized by alias when an alias is used. - + 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). """ - ), - ] = True, - response_model_exclude_unset: Annotated[ - bool, - Doc( - """ + ), + ] = True, + response_model_exclude_unset: Annotated[ + bool, + Doc( + """ Configuration passed to Pydantic to define if the response data should have all the fields, including the ones that were not set and have their default values. This is different from `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 as the default. - + When `True`, default values are omitted from the response. - + 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). """ - ), - ] = False, - response_model_exclude_defaults: Annotated[ - bool, - Doc( - """ + ), + ] = False, + response_model_exclude_defaults: Annotated[ + bool, + Doc( + """ Configuration passed to Pydantic to define if the response data should have all the fields, including the ones that have the same value as the default. This is different from `response_model_exclude_unset` in that if the fields are set but contain the same default values, they will be excluded from the response. - + When `True`, default values are omitted from the response. - + 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). """ - ), - ] = False, - response_model_exclude_none: Annotated[ - bool, - Doc( - """ + ), + ] = False, + response_model_exclude_none: Annotated[ + bool, + Doc( + """ Configuration passed to Pydantic to define if the response data should exclude fields set to `None`. - + This is much simpler (less smart) than `response_model_exclude_unset` and `response_model_exclude_defaults`. You probably want to use one of those two instead of this one, as those allow returning `None` values when it makes sense. - + Read more about it in the [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none). """ - ), - ] = False, - include_in_schema: Annotated[ - bool, - Doc( - """ + ), + ] = False, + include_in_schema: Annotated[ + bool, + Doc( + """ Include this *path operation* in the generated OpenAPI schema. - + This affects the generated OpenAPI (e.g. visible at `/docs`). - + 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). """ - ), - ] = True, - response_class: Annotated[ - Type[Response], - Doc( - """ + ), + ] = True, + response_class: Annotated[ + Type[Response], + Doc( + """ Response class to be used for this *path operation*. - + This will not be used if you return a response directly. - + Read more about it in the [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse). """ - ), - ] = Default(JSONResponse), - name: Annotated[ - Optional[str], - Doc( - """ + ), + ] = Default(JSONResponse), + name: Annotated[ + Optional[str], + Doc( + """ Name for this *path operation*. Only used internally. """ - ), - ] = None, - callbacks: Annotated[ - Optional[List[BaseRoute]], - Doc( - """ + ), + ] = None, + callbacks: Annotated[ + Optional[List[BaseRoute]], + Doc( + """ List of *path operations* that will be used as OpenAPI callbacks. - + This is only for OpenAPI documentation, the callbacks won't be used directly. - + It will be added to the generated OpenAPI (e.g. visible at `/docs`). - + Read more about it in the [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/). """ - ), - ] = None, - openapi_extra: Annotated[ - Optional[Dict[str, Any]], - Doc( - """ + ), + ] = None, + openapi_extra: Annotated[ + Optional[Dict[str, Any]], + Doc( + """ Extra metadata to be included in the OpenAPI schema for this *path operation*. - + 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). """ - ), - ] = None, - generate_unique_id_function: Annotated[ - Callable[[routing.APIRoute], str], - Doc( - """ + ), + ] = None, + generate_unique_id_function: Annotated[ + Callable[[routing.APIRoute], str], + Doc( + """ Customize the function used to generate unique IDs for the *path operations* shown in the generated OpenAPI. - + This is particularly useful when automatically generating clients or SDKs for your API. - + 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). """ - ), - ] = Default(generate_unique_id), + ), + ] = Default(generate_unique_id), ) -> Callable[[DecoratedCallable], DecoratedCallable]: """ Add a *path operation* using an HTTP QUERY operation. diff --git a/fastapi/routing.py b/fastapi/routing.py index 0726552c1..723e7f33b 100644 --- a/fastapi/routing.py +++ b/fastapi/routing.py @@ -4489,30 +4489,30 @@ class APIRouter(routing.Router): ) def query( - self, - path: Annotated[ - str, - Doc( - """ + self, + path: Annotated[ + str, + Doc( + """ The URL path to be used for this *path operation*. - + For example, in `http://example.com/items`, the path is `/items`. """ - ), - ], - *, - response_model: Annotated[ - Any, - Doc( - """ + ), + ], + *, + response_model: Annotated[ + Any, + Doc( + """ The type to use for the response. - + 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`, etc. - + It will be used for: - + * Documentation: the generated OpenAPI (and the UI at `/docs`) will show it as the response (JSON Schema). * 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, so it's an error from the API developer. So, FastAPI will raise an error and return a 500 error code (Internal Server Error). - + Read more about it in the [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/). """ - ), - ] = Default(None), - status_code: Annotated[ - Optional[int], - Doc( - """ + ), + ] = Default(None), + status_code: Annotated[ + Optional[int], + Doc( + """ The default status code to be used for the response. - + You could override the status code by returning a response directly. - + Read more about it in the [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/). """ - ), - ] = None, - tags: Annotated[ - Optional[List[Union[str, Enum]]], - Doc( - """ + ), + ] = None, + tags: Annotated[ + Optional[List[Union[str, Enum]]], + Doc( + """ A list of tags to be applied to the *path operation*. - + It will be added to the generated OpenAPI (e.g. visible at `/docs`). - + Read more about it in the [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags). """ - ), - ] = None, - dependencies: Annotated[ - Optional[Sequence[params.Depends]], - Doc( - """ + ), + ] = None, + dependencies: Annotated[ + Optional[Sequence[params.Depends]], + Doc( + """ A list of dependencies (using `Depends()`) to be applied to the *path operation*. - + 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/). """ - ), - ] = None, - summary: Annotated[ - Optional[str], - Doc( - """ + ), + ] = None, + summary: Annotated[ + Optional[str], + Doc( + """ A summary for the *path operation*. - + It will be added to the generated OpenAPI (e.g. visible at `/docs`). - + Read more about it in the [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/). """ - ), - ] = None, - description: Annotated[ - Optional[str], - Doc( - """ + ), + ] = None, + description: Annotated[ + Optional[str], + Doc( + """ A description for the *path operation*. - + If not provided, it will be extracted automatically from the docstring of the *path operation function*. - + It can contain Markdown. - + It will be added to the generated OpenAPI (e.g. visible at `/docs`). - + Read more about it in the [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/). """ - ), - ] = None, - response_description: Annotated[ - str, - Doc( - """ + ), + ] = None, + response_description: Annotated[ + str, + Doc( + """ The description for the default response. - + It will be added to the generated OpenAPI (e.g. visible at `/docs`). """ - ), - ] = "Successful Response", - responses: Annotated[ - Optional[Dict[Union[int, str], Dict[str, Any]]], - Doc( - """ + ), + ] = "Successful Response", + responses: Annotated[ + Optional[Dict[Union[int, str], Dict[str, Any]]], + Doc( + """ Additional responses that could be returned by this *path operation*. - + It will be added to the generated OpenAPI (e.g. visible at `/docs`). """ - ), - ] = None, - deprecated: Annotated[ - Optional[bool], - Doc( - """ + ), + ] = None, + deprecated: Annotated[ + Optional[bool], + Doc( + """ Mark this *path operation* as deprecated. - + It will be added to the generated OpenAPI (e.g. visible at `/docs`). """ - ), - ] = None, - operation_id: Annotated[ - Optional[str], - Doc( - """ + ), + ] = None, + operation_id: Annotated[ + Optional[str], + Doc( + """ Custom operation ID to be used by this *path operation*. - + By default, it is generated automatically. - + If you provide a custom operation ID, you need to make sure it is unique for the whole API. - + You can customize the operation ID generation with the parameter `generate_unique_id_function` in the `FastAPI` class. - + 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). """ - ), - ] = None, - response_model_include: Annotated[ - Optional[IncEx], - Doc( - """ + ), + ] = None, + response_model_include: Annotated[ + Optional[IncEx], + Doc( + """ Configuration passed to Pydantic to include only certain fields in the response data. - + 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). """ - ), - ] = None, - response_model_exclude: Annotated[ - Optional[IncEx], - Doc( - """ + ), + ] = None, + response_model_exclude: Annotated[ + Optional[IncEx], + Doc( + """ Configuration passed to Pydantic to exclude certain fields in the response data. - + 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). """ - ), - ] = None, - response_model_by_alias: Annotated[ - bool, - Doc( - """ + ), + ] = None, + response_model_by_alias: Annotated[ + bool, + Doc( + """ Configuration passed to Pydantic to define if the response model should be serialized by alias when an alias is used. - + 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). """ - ), - ] = True, - response_model_exclude_unset: Annotated[ - bool, - Doc( - """ + ), + ] = True, + response_model_exclude_unset: Annotated[ + bool, + Doc( + """ Configuration passed to Pydantic to define if the response data should have all the fields, including the ones that were not set and have their default values. This is different from `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 as the default. - + When `True`, default values are omitted from the response. - + 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). """ - ), - ] = False, - response_model_exclude_defaults: Annotated[ - bool, - Doc( - """ + ), + ] = False, + response_model_exclude_defaults: Annotated[ + bool, + Doc( + """ Configuration passed to Pydantic to define if the response data should have all the fields, including the ones that have the same value as the default. This is different from `response_model_exclude_unset` in that if the fields are set but contain the same default values, they will be excluded from the response. - + When `True`, default values are omitted from the response. - + 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). """ - ), - ] = False, - response_model_exclude_none: Annotated[ - bool, - Doc( - """ + ), + ] = False, + response_model_exclude_none: Annotated[ + bool, + Doc( + """ Configuration passed to Pydantic to define if the response data should exclude fields set to `None`. - + This is much simpler (less smart) than `response_model_exclude_unset` and `response_model_exclude_defaults`. You probably want to use one of those two instead of this one, as those allow returning `None` values when it makes sense. - + Read more about it in the [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none). """ - ), - ] = False, - include_in_schema: Annotated[ - bool, - Doc( - """ + ), + ] = False, + include_in_schema: Annotated[ + bool, + Doc( + """ Include this *path operation* in the generated OpenAPI schema. - + This affects the generated OpenAPI (e.g. visible at `/docs`). - + 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). """ - ), - ] = True, - response_class: Annotated[ - Type[Response], - Doc( - """ + ), + ] = True, + response_class: Annotated[ + Type[Response], + Doc( + """ Response class to be used for this *path operation*. - + This will not be used if you return a response directly. - + Read more about it in the [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse). """ - ), - ] = Default(JSONResponse), - name: Annotated[ - Optional[str], - Doc( - """ + ), + ] = Default(JSONResponse), + name: Annotated[ + Optional[str], + Doc( + """ Name for this *path operation*. Only used internally. """ - ), - ] = None, - callbacks: Annotated[ - Optional[List[BaseRoute]], - Doc( - """ + ), + ] = None, + callbacks: Annotated[ + Optional[List[BaseRoute]], + Doc( + """ List of *path operations* that will be used as OpenAPI callbacks. - + This is only for OpenAPI documentation, the callbacks won't be used directly. - + It will be added to the generated OpenAPI (e.g. visible at `/docs`). - + Read more about it in the [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/). """ - ), - ] = None, - openapi_extra: Annotated[ - Optional[Dict[str, Any]], - Doc( - """ + ), + ] = None, + openapi_extra: Annotated[ + Optional[Dict[str, Any]], + Doc( + """ Extra metadata to be included in the OpenAPI schema for this *path operation*. - + 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). """ - ), - ] = None, - generate_unique_id_function: Annotated[ - Callable[[APIRoute], str], - Doc( - """ + ), + ] = None, + generate_unique_id_function: Annotated[ + Callable[[APIRoute], str], + Doc( + """ Customize the function used to generate unique IDs for the *path operations* shown in the generated OpenAPI. - + This is particularly useful when automatically generating clients or SDKs for your API. - + 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). """ - ), - ] = Default(generate_unique_id), + ), + ] = Default(generate_unique_id), ) -> Callable[[DecoratedCallable], DecoratedCallable]: """ Add a *path operation* using an HTTP QUERY operation. diff --git a/tests/test_http_query_method.py b/tests/test_http_query_method.py index 7006ec851..9219fbd2b 100644 --- a/tests/test_http_query_method.py +++ b/tests/test_http_query_method.py @@ -37,9 +37,7 @@ client = TestClient(app) def test_query_item(): - response = client.request( - "QUERY", "/items/", json={"name": "Foo", "price": 50.5} - ) + response = client.request("QUERY", "/items/", json={"name": "Foo", "price": 50.5}) assert response.status_code == 200 assert response.json() == { "name": "Foo", @@ -285,4 +283,4 @@ def test_openapi_schema(): }, } }, - } \ No newline at end of file + }