Search Options

Results per page
Sort
Preferred Languages
Advance

Results 1 - 10 of 61 for define (0.16 sec)

  1. 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**.
    
    Plain Text
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 7.8K bytes
    - Viewed (0)
  2. 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
    
    Python
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Tue Apr 23 22:29:18 GMT 2024
    - 9.1K bytes
    - Viewed (0)
  3. 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`:
    
    === "Python 3.10+"
    
        ```Python hl_lines="3"
        {!> ../../../docs_src/header_params/tutorial001_an_py310.py!}
        ```
    
    === "Python 3.9+"
    
        ```Python hl_lines="3"
        {!> ../../../docs_src/header_params/tutorial001_an_py39.py!}
        ```
    
    === "Python 3.8+"
    Plain Text
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Tue Oct 17 05:59:11 GMT 2023
    - 5.8K bytes
    - Viewed (0)
  4. docs/pt/docs/tutorial/header-params.md

    # Parâmetros de Cabeçalho
    
    Você pode definir parâmetros de Cabeçalho da mesma maneira que define paramêtros com `Query`, `Path` e `Cookie`.
    
    ## importe `Header`
    
    Primeiro importe `Header`:
    
    === "Python 3.10+"
    
        ```Python hl_lines="1"
        {!> ../../../docs_src/header_params/tutorial001_py310.py!}
        ```
    
    === "Python 3.8+"
    
        ```Python hl_lines="3"
        {!> ../../../docs_src/header_params/tutorial001.py!}
        ```
    
    Plain Text
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Tue Oct 17 05:59:11 GMT 2023
    - 3.9K bytes
    - Viewed (0)
  5. 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.
    Plain Text
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Sat Jun 24 14:47:15 GMT 2023
    - 4.3K bytes
    - Viewed (0)
  6. 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
    ```
    
    Plain Text
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 359 bytes
    - Viewed (0)
  7. docs/en/docs/advanced/openapi-webhooks.md

    This is normally called a **webhook**.
    
    ## Webhooks steps
    
    The process normally is that **you define** in your code what is the message that you will send, the **body of the request**.
    
    You also define in some way at which **moments** your app will send those requests or events.
    
    And **your users** define in some way (for example in a web dashboard somewhere) the **URL** where your app should send those requests.
    
    Plain Text
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Fri Jun 30 18:25:16 GMT 2023
    - 2.8K bytes
    - Viewed (0)
  8. 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:
    Plain Text
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Tue Oct 17 05:59:11 GMT 2023
    - 5.6K bytes
    - Viewed (0)
  9. docs/pt/docs/tutorial/security/index.md

    OpenAPI tem uma forma para definir múltiplos “esquemas” de segurança.
    
    Por usá-los, você pode ter vantagens de todas essas ferramentas baseadas nos padrões, incluindo os sistemas de documentação interativa.
    
    OpenAPI define os seguintes esquemas de segurança:
    
    * `apiKey`: uma chave específica de aplicação que pode vir de:
        * Um parâmetro query.
    Plain Text
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Sat Jun 24 14:47:15 GMT 2023
    - 4.8K bytes
    - Viewed (0)
  10. docs/en/docs/advanced/path-operation-advanced-configuration.md

    So, you could add additional data to the automatically generated schema.
    
    For example, you could decide to read and validate the request with your own code, without using the automatic features of FastAPI with Pydantic, but you could still want to define the request in the OpenAPI schema.
    
    You could do that with `openapi_extra`:
    
    ```Python hl_lines="20-37  39-40"
    Plain Text
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 7.7K bytes
    - Viewed (0)
Back to top