Search Options

Results per page
Sort
Preferred Languages
Advance

Results 1 - 10 of 126 for Parameters (0.27 sec)

  1. 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 May 05 07:19:11 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 603 bytes
    - Viewed (0)
  2. 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 May 05 07:19:11 GMT 2024
    - Last Modified: Sat Mar 30 18:17:26 GMT 2024
    - 635 bytes
    - Viewed (0)
  3. docs/en/docs/tutorial/path-params.md

    ```
    /files/{file_path:path}
    ```
    
    In this case, the name of the parameter is `file_path`, and the last part, `:path`, tells it that the parameter should match any *path*.
    
    So, you can use it with:
    
    ```Python hl_lines="6"
    {!../../../docs_src/path_params/tutorial004.py!}
    ```
    
    !!! tip
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Fri Mar 22 01:42:11 GMT 2024
    - 9.1K bytes
    - Viewed (0)
  4. tests/test_tutorial/test_dependencies/test_tutorial012_an.py

            "paths": {
                "/items/": {
                    "get": {
                        "summary": "Read Items",
                        "operationId": "read_items_items__get",
                        "parameters": [
                            {
                                "required": True,
                                "schema": {"title": "X-Token", "type": "string"},
                                "name": "x-token",
    Python
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Thu Apr 18 19:40:57 GMT 2024
    - 8.4K bytes
    - Viewed (0)
  5. docs/en/docs/tutorial/request-forms-and-files.md

            Prefer to use the `Annotated` version if possible.
    
        ```Python hl_lines="1"
        {!> ../../../docs_src/request_forms_and_files/tutorial001.py!}
        ```
    
    ## Define `File` and `Form` parameters
    
    Create file and form parameters the same way you would for `Body` or `Query`:
    
    === "Python 3.9+"
    
        ```Python hl_lines="10-12"
        {!> ../../../docs_src/request_forms_and_files/tutorial001_an_py39.py!}
        ```
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Wed Mar 13 19:02:19 GMT 2024
    - 2K bytes
    - Viewed (0)
  6. tests/test_tutorial/test_query_params/test_tutorial006_py310.py

                            },
                        },
                        "summary": "Read User Item",
                        "operationId": "read_user_item_items__item_id__get",
                        "parameters": [
                            {
                                "required": True,
                                "schema": {"title": "Item Id", "type": "string"},
                                "name": "item_id",
    Python
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Thu Apr 18 19:40:57 GMT 2024
    - 6.2K bytes
    - Viewed (0)
  7. tests/test_tutorial/test_query_params_str_validations/test_tutorial010_an.py

                                },
                            },
                        },
                        "summary": "Read Items",
                        "operationId": "read_items_items__get",
                        "parameters": [
                            {
                                "description": "Query string for the items to search in the database that have a good match",
                                "required": False,
    Python
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Thu Apr 18 19:40:57 GMT 2024
    - 6.2K bytes
    - Viewed (0)
  8. tests/test_tutorial/test_extra_data_types/test_tutorial001.py

                                },
                            },
                        },
                        "summary": "Read Items",
                        "operationId": "read_items_items__item_id__put",
                        "parameters": [
                            {
                                "required": True,
                                "schema": {
                                    "title": "Item Id",
                                    "type": "string",
    Python
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Fri Apr 19 00:11:40 GMT 2024
    - 6.8K bytes
    - Viewed (0)
  9. docs/en/docs/reference/uploadfile.md

    # `UploadFile` class
    
    You can define *path operation function* parameters to be of the type `UploadFile` to receive files from the request.
    
    You can import it directly from `fastapi`:
    
    ```python
    from fastapi import UploadFile
    ```
    
    ::: fastapi.UploadFile
        options:
            members:
                - file
                - filename
                - size
                - headers
                - content_type
                - read
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 472 bytes
    - Viewed (0)
  10. docs/de/docs/advanced/events.md

    ```
    
    ## Alternative Events (deprecated)
    
    !!! warning "Achtung"
        Der empfohlene Weg, das *Hochfahren* und *Herunterfahren* zu handhaben, ist die Verwendung des `lifespan`-Parameters der `FastAPI`-App, wie oben beschrieben. Wenn Sie einen `lifespan`-Parameter übergeben, werden die `startup`- und `shutdown`-Eventhandler nicht mehr aufgerufen. Es ist entweder alles `lifespan` oder alles Events, nicht beides.
    
        Sie können diesen Teil wahrscheinlich überspringen.
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Sat Mar 30 20:30:59 GMT 2024
    - 9.1K bytes
    - Viewed (0)
Back to top