parameters - Code Search

docs/en/docs/reference/parameters.md

# Request Parameters

Here's the reference information for the request parameters.

These are the special functions that you can put in *path operation function* parameters or dependency functions with `Annotated` to get data from the request.

It includes:

* `Query()`
* `Path()`
* `Body()`
* `Cookie()`
* `Header()`
* `Form()`
* `File()`

You can import them all directly from `fastapi`:

```python

Plain Text

- Registered: Sun Apr 21 07:19:11 GMT 2024

- Last Modified: Thu Apr 18 19:53:19 GMT 2024

- 603 bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs/de/docs/reference/parameters.md

# Request-Parameter

Hier die Referenzinformationen für die Request-Parameter.

Dies sind die Sonderfunktionen, die Sie mittels `Annotated` in *Pfadoperation-Funktion*-Parameter oder Abhängigkeitsfunktionen einfügen können, um Daten aus dem Request abzurufen.

Dies beinhaltet:

* `Query()`
* `Path()`
* `Body()`
* `Cookie()`
* `Header()`
* `Form()`
* `File()`

Sie können diese alle direkt von `fastapi` importieren:

```python

Plain Text

- Registered: Sun Apr 21 07:19:11 GMT 2024

- Last Modified: Sat Mar 30 18:17:26 GMT 2024

- 635 bytes

- Viewed (0)

github.com/tiangolo/fastapi

tests/test_request_body_parameters_media_type.py

Sebastián Ramírez <******@****.***> 1688749933 +0200

Python

- Registered: Sun Apr 21 07:19:11 GMT 2024

- Last Modified: Fri Jul 07 17:12:13 GMT 2023

- 6.4K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs/en/docs/tutorial/body.md

    {!> ../../../docs_src/body/tutorial004.py!}
    ```

The function parameters will be recognized as follows:

* If the parameter is also declared in the **path**, it will be used as a path parameter.
* If the parameter is of a **singular type** (like `int`, `float`, `str`, `bool`, etc) it will be interpreted as a **query** parameter.

Plain Text

- Registered: Sun Apr 21 07:19:11 GMT 2024

- Last Modified: Fri Mar 22 01:42:11 GMT 2024

- 7.3K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs/de/docs/how-to/configure-swagger-ui.md

Um diese zu konfigurieren, übergeben Sie das Argument `swagger_ui_parameters` beim Erstellen des `FastAPI()`-App-Objekts oder an die Funktion `get_swagger_ui_html()`.

`swagger_ui_parameters` empfängt ein Dict mit den Konfigurationen, die direkt an die Swagger-Oberfläche übergeben werden.

Plain Text

- Registered: Sun Apr 21 07:19:11 GMT 2024

- Last Modified: Sat Mar 30 18:17:49 GMT 2024

- 3.3K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs/en/docs/tutorial/request-forms.md

!!! info
    `Form` is a class that inherits directly from `Body`.

!!! tip
    To declare form bodies, you need to use `Form` explicitly, because without it the parameters would be interpreted as query parameters or body (JSON) parameters.

## About "Form Fields"

The way HTML forms (`<form></form>`) sends the data to the server normally uses a "special" encoding for that data, it's different from JSON.

Plain Text

- Registered: Sun Apr 21 07:19:11 GMT 2024

- Last Modified: Wed Mar 13 19:02:19 GMT 2024

- 3.2K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs/en/docs/tutorial/query-params.md

    {!> ../../../docs_src/query_params/tutorial002.py!}
    ```

In this case, the function parameter `q` will be optional, and will be `None` by default.

!!! check
    Also notice that **FastAPI** is smart enough to notice that the path parameter `item_id` is a path parameter and `q` is not, so, it's a query parameter.

## Query parameter type conversion

You can also declare `bool` types, and they will be converted:

Plain Text

- Registered: Sun Apr 21 07:19:11 GMT 2024

- Last Modified: Fri Oct 20 09:08:42 GMT 2023

- 5.1K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs_src/dependencies/tutorial001_an_py310.py

app = FastAPI()


async def common_parameters(q: str | None = None, skip: int = 0, limit: int = 100):
    return {"q": q, "skip": skip, "limit": limit}


@app.get("/items/")
async def read_items(commons: Annotated[dict, Depends(common_parameters)]):
    return commons


@app.get("/users/")
async def read_users(commons: Annotated[dict, Depends(common_parameters)]):

Python

- Registered: Sun Apr 21 07:19:11 GMT 2024

- Last Modified: Sat Mar 18 12:29:59 GMT 2023

- 454 bytes

- Viewed (0)

github.com/tiangolo/fastapi

fastapi/openapi/docs.py

    """
    current_swagger_ui_parameters = swagger_ui_default_parameters.copy()
    if swagger_ui_parameters:
        current_swagger_ui_parameters.update(swagger_ui_parameters)

    html = f"""
    <!DOCTYPE html>
    <html>
    <head>
    <link type="text/css" rel="stylesheet" href="{swagger_css_url}">

Python

- Registered: Sun Apr 21 07:19:11 GMT 2024

- Last Modified: Tue Apr 02 02:48:51 GMT 2024

- 10.1K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs_src/dependency_testing/tutorial001_an.py

from typing_extensions import Annotated

app = FastAPI()


async def common_parameters(
    q: Union[str, None] = None, skip: int = 0, limit: int = 100
):
    return {"q": q, "skip": skip, "limit": limit}


@app.get("/items/")
async def read_items(commons: Annotated[dict, Depends(common_parameters)]):
    return {"message": "Hello Items!", "params": commons}


@app.get("/users/")

Python

- Registered: Sun Apr 21 07:19:11 GMT 2024

- Last Modified: Sat Mar 18 12:29:59 GMT 2023

- 1.5K bytes

- Viewed (0)

Search Options