Search Options

Results per page
Sort
Preferred Languages
Advance

Results 1 - 10 of 111 for define (0.06 sec)

  1. docs/en/docs/reference/httpconnection.md

    # `HTTPConnection` class
    
    When you want to define dependencies that should be compatible with both HTTP and WebSockets, you can define a parameter that takes an `HTTPConnection` instead of a `Request` or a `WebSocket`.
    
    You can import it from `fastapi.requests`:
    
    ```python
    from fastapi.requests import HTTPConnection
    ```
    
    Registered: Sun Nov 03 07:19:11 UTC 2024
    - Last Modified: Thu Apr 18 19:53:19 UTC 2024
    - 359 bytes
    - Viewed (0)
  2. docs/en/docs/tutorial/cookie-params.md

    # Cookie Parameters
    
    You can define Cookie parameters the same way you define `Query` and `Path` parameters.
    
    ## Import `Cookie`
    
    First import `Cookie`:
    
    //// tab | Python 3.10+
    
    ```Python hl_lines="3"
    {!> ../../docs_src/cookie_params/tutorial001_an_py310.py!}
    ```
    
    ////
    
    //// tab | Python 3.9+
    
    ```Python hl_lines="3"
    {!> ../../docs_src/cookie_params/tutorial001_an_py39.py!}
    ```
    
    ////
    
    Registered: Sun Nov 03 07:19:11 UTC 2024
    - Last Modified: Sun Oct 06 20:36:54 UTC 2024
    - 2.3K bytes
    - Viewed (0)
  3. docs/en/docs/reference/request.md

    You can import it directly from `fastapi`:
    
    ```python
    from fastapi import Request
    ```
    
    /// tip
    
    When you want to define dependencies that should be compatible with both HTTP and WebSockets, you can define a parameter that takes an `HTTPConnection` instead of a `Request` or a `WebSocket`.
    
    ///
    
    Registered: Sun Nov 03 07:19:11 UTC 2024
    - Last Modified: Tue Aug 06 04:48:30 UTC 2024
    - 518 bytes
    - Viewed (0)
  4. docs/pt/docs/advanced/openapi-webhooks.md

    Isso normalmente é chamado de **webhook**.
    
    ## Etapas dos Webhooks
    
    Normalmente, o processo é que **você define** em seu código qual é a mensagem que você irá mandar, o **corpo da sua requisição**.
    
    Você também define de alguma maneira em quais **momentos** a sua aplicação mandará essas requisições ou eventos.
    
    E os **seus usuários** definem de alguma forma (em algum painel por exemplo) a **URL** que a sua aplicação deve enviar essas requisições.
    
    Registered: Sun Nov 03 07:19:11 UTC 2024
    - Last Modified: Sun Oct 06 20:36:54 UTC 2024
    - 3.3K bytes
    - Viewed (0)
  5. docs/en/docs/tutorial/header-params.md

    # Header Parameters
    
    You can define Header parameters the same way you define `Query`, `Path` and `Cookie` parameters.
    
    ## Import `Header`
    
    First import `Header`:
    
    //// tab | Python 3.10+
    
    ```Python hl_lines="3"
    {!> ../../docs_src/header_params/tutorial001_an_py310.py!}
    ```
    
    ////
    
    //// tab | Python 3.9+
    
    ```Python hl_lines="3"
    {!> ../../docs_src/header_params/tutorial001_an_py39.py!}
    ```
    
    ////
    
    Registered: Sun Nov 03 07:19:11 UTC 2024
    - Last Modified: Sun Oct 06 20:36:54 UTC 2024
    - 5.6K bytes
    - Viewed (0)
  6. docs/en/docs/reference/websockets.md

    It is provided directly by Starlette, but you can import it from `fastapi`:
    
    ```python
    from fastapi import WebSocket
    ```
    
    /// tip
    
    When you want to define dependencies that should be compatible with both HTTP and WebSockets, you can define a parameter that takes an `HTTPConnection` instead of a `Request` or a `WebSocket`.
    
    ///
    
    ::: fastapi.WebSocket
        options:
            members:
                - scope
    Registered: Sun Nov 03 07:19:11 UTC 2024
    - Last Modified: Tue Aug 06 04:48:30 UTC 2024
    - 1.7K bytes
    - Viewed (0)
  7. docs/en/docs/tutorial/security/index.md

    That's what makes it possible to have multiple automatic interactive documentation interfaces, code generation, etc.
    
    OpenAPI has a way to define multiple security "schemes".
    
    By using them, you can take advantage of all these standard-based tools, including these interactive documentation systems.
    
    OpenAPI defines the following security schemes:
    
    * `apiKey`: an application specific key that can come from:
        * A query parameter.
        * A header.
    Registered: Sun Nov 03 07:19:11 UTC 2024
    - Last Modified: Tue Aug 06 04:48:30 UTC 2024
    - 4.3K bytes
    - Viewed (0)
  8. fastapi/security/api_key.py

        """
        API key authentication using a query parameter.
    
        This defines the name of the query parameter that should be provided in the request
        with the API key and integrates that into the OpenAPI documentation. It extracts
        the key value sent in the query parameter automatically and provides it as the
        dependency result. But it doesn't define how to send that API key to the client.
    
        ## Usage
    
    Registered: Sun Nov 03 07:19:11 UTC 2024
    - Last Modified: Tue Apr 23 22:29:18 UTC 2024
    - 9.1K bytes
    - Viewed (0)
  9. docs/en/docs/tutorial/background-tasks.md

    # Background Tasks
    
    You can define background tasks to be run *after* returning a response.
    
    This is useful for operations that need to happen after a request, but that the client doesn't really have to be waiting for the operation to complete before receiving the response.
    
    This includes, for example:
    
    * Email notifications sent after performing an action:
    Registered: Sun Nov 03 07:19:11 UTC 2024
    - Last Modified: Sun Oct 27 15:22:48 UTC 2024
    - 4.8K bytes
    - Viewed (0)
  10. docs/en/docs/advanced/events.md

    # Lifespan Events
    
    You can define logic (code) that should be executed before the application **starts up**. This means that this code will be executed **once**, **before** the application **starts receiving requests**.
    
    The same way, you can define logic (code) that should be executed when the application is **shutting down**. In this case, this code will be executed **once**, **after** having handled possibly **many requests**.
    
    Registered: Sun Nov 03 07:19:11 UTC 2024
    - Last Modified: Mon Oct 28 10:36:22 UTC 2024
    - 7.6K bytes
    - Viewed (0)
Back to top