Search Options

Results per page
Sort
Preferred Languages
Advance

Results 1 - 10 of 108 for declare (0.27 sec)

  1. docs/en/docs/tutorial/body-fields.md

    # Body - Fields
    
    The same way you can declare additional validation and metadata in *path operation function* parameters with `Query`, `Path` and `Body`, you can declare validation and metadata inside of Pydantic models using Pydantic's `Field`.
    
    ## Import `Field`
    
    First, you have to import it:
    
    === "Python 3.10+"
    
        ```Python hl_lines="4"
        {!> ../../../docs_src/body_fields/tutorial001_an_py310.py!}
        ```
    
    === "Python 3.9+"
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Tue Oct 17 05:59:11 GMT 2023
    - 3.6K bytes
    - Viewed (0)
  2. docs/en/docs/tutorial/path-params.md

    ```JSON
    {"item_id":"foo"}
    ```
    
    ## Path parameters with types
    
    You can declare the type of a path parameter in the function, using standard Python type annotations:
    
    ```Python hl_lines="7"
    {!../../../docs_src/path_params/tutorial002.py!}
    ```
    
    In this case, `item_id` is declared to be an `int`.
    
    !!! check
        This will give you editor support inside of your function, with error checks, completion, etc.
    
    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)
  3. docs/en/docs/tutorial/response-model.md

    !!! tip
        If you have strict type checks in your editor, mypy, etc, you can declare the function return type as `Any`.
    
        That way you tell the editor that you are intentionally returning anything. But FastAPI will still do the data documentation, validation, filtering, etc. with the `response_model`.
    
    ### `response_model` Priority
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 17.9K bytes
    - Viewed (0)
  4. fastapi/param_functions.py

        ] = True,
    ) -> Any:
        """
        Declare a FastAPI Security dependency.
    
        The only difference with a regular dependency is that it can declare OAuth2
        scopes that will be integrated with OpenAPI and the automatic UI docs (by default
        at `/docs`).
    
        It takes a single "dependable" callable (like a function).
    
        Don't call it directly, FastAPI will call it for you.
    
        Read more about it in the
    Python
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu Apr 18 19:40:57 GMT 2024
    - 62.5K bytes
    - Viewed (0)
  5. docs/en/docs/alternatives.md

    The dependency injection system requires pre-registration of the dependencies and the dependencies are solved based on the declared types. So, it's not possible to declare more than one "component" that provides a certain type.
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 23.2K bytes
    - Viewed (0)
  6. docs/en/docs/reference/background.md

    # Background Tasks - `BackgroundTasks`
    
    You can declare a parameter in a *path operation function* or dependency function with the type `BackgroundTasks`, and then you can use it to schedule the execution of background tasks after the response is sent.
    
    You can import it directly from `fastapi`:
    
    ```python
    from fastapi import BackgroundTasks
    ```
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 377 bytes
    - Viewed (0)
  7. docs/en/docs/reference/request.md

    # `Request` class
    
    You can declare a parameter in a *path operation function* or dependency to be of type `Request` and then you can access the raw request object directly, without any validation, etc.
    
    You can import it directly from `fastapi`:
    
    ```python
    from fastapi import Request
    ```
    
    !!! tip
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 516 bytes
    - Viewed (0)
  8. docs/en/docs/tutorial/security/get-current-user.md

        ```Python hl_lines="31"
        {!> ../../../docs_src/security/tutorial002.py!}
        ```
    
    Notice that we declare the type of `current_user` as the Pydantic model `User`.
    
    This will help us inside of the function with all the completion and type checks.
    
    !!! tip
        You might remember that request bodies are also declared with Pydantic models.
    
        Here **FastAPI** won't get confused because you are using `Depends`.
    
    !!! check
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu Jan 11 16:31:18 GMT 2024
    - 7.6K bytes
    - Viewed (0)
  9. docs/en/docs/tutorial/body-multiple-params.md

    You can also declare singular values to be received as part of the body.
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Tue Oct 17 05:59:11 GMT 2023
    - 7.7K bytes
    - Viewed (0)
  10. docs/en/docs/python-types.md

    ```Python hl_lines="2"
    {!../../../docs_src/python_types/tutorial004.py!}
    ```
    
    ## Declaring types
    
    You just saw the main place to declare type hints. As function parameters.
    
    This is also the main place you would use them with **FastAPI**.
    
    ### Simple types
    
    You can declare all the standard Python types, not only `str`.
    
    You can use, for example:
    
    * `int`
    * `float`
    * `bool`
    * `bytes`
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 17K bytes
    - Viewed (0)
Back to top