Search Options

Results per page
Sort
Preferred Languages
Advance

Results 1 - 10 of 35 for defined (0.22 sec)

  1. docs/en/docs/advanced/generate-clients.md

    You will also get autocompletion for the payload to send:
    
    <img src="/img/tutorial/generate-clients/image03.png">
    
    !!! tip
        Notice the autocompletion for `name` and `price`, that was defined in the FastAPI application, in the `Item` model.
    
    You will have inline errors for the data that you send:
    
    <img src="/img/tutorial/generate-clients/image04.png">
    
    The response object will also have autocompletion:
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 10.5K bytes
    - Viewed (0)
  2. docs/en/docs/advanced/behind-a-proxy.md

    ### Check the docs UI
    
    But here's the fun part. ✨
    
    The "official" way to access the app would be through the proxy with the path prefix that we defined. So, as we would expect, if you try the docs UI served by Uvicorn directly, without the path prefix in the URL, it won't work, because it expects to be accessed through the proxy.
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu May 02 22:37:31 GMT 2024
    - 11.6K bytes
    - Viewed (2)
  3. docs/en/docs/tutorial/response-model.md

        * This will be used by the **automatic docs**.
        * It will also be used by automatic client code generation tools.
    
    But most importantly:
    
    * It will **limit and filter** the output data to what is defined in the return type.
        * This is particularly important for **security**, we'll see more of that below.
    
    ## `response_model` Parameter
    
    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. docs/en/docs/async.md

        return burgers
    ```
    
    ### More technical details
    
    You might have noticed that `await` can only be used inside of functions defined with `async def`.
    
    But at the same time, functions defined with `async def` have to be "awaited". So, functions with `async def` can only be called inside of functions defined with `async def` too.
    
    So, about the egg and the chicken, how do you call the first `async` function?
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 23K bytes
    - Viewed (0)
  5. docs/en/docs/python-types.md

    As an example, let's take this function:
    
    ```Python hl_lines="1  4"
    {!../../../docs_src/python_types/tutorial009c.py!}
    ```
    
    The parameter `name` is defined as `Optional[str]`, but it is **not optional**, you cannot call the function without the parameter:
    
    ```Python
    say_hi()  # Oh, no, this throws an error! 😱
    ```
    
    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)
  6. docs/en/docs/alternatives.md

    But it was created before there existed Python type hints. So, to define every <abbr title="the definition of how data should be formed">schema</abbr> you need to use specific utils and classes provided by Marshmallow.
    
    !!! check "Inspired **FastAPI** to"
        Use code to define "schemas" that provide data types and validation, automatically.
    
    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)
  7. docs/en/docs/tutorial/first-steps.md

    In that case, it would mean the JSON attributes, and data types they have, etc.
    
    #### OpenAPI and JSON Schema
    
    OpenAPI defines an API schema for your API. And that schema includes definitions (or "schemas") of the data sent and received by your API using **JSON Schema**, the standard for JSON data schemas.
    
    #### Check the `openapi.json`
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu May 02 22:37:31 GMT 2024
    - 12K bytes
    - Viewed (0)
  8. docs/em/docs/tutorial/query-params-str-validations.md

        {!> ../../../docs_src/query_params_str_validations/tutorial003_py310.py!}
        ```
    
    ## 🚮 🥔 🧬
    
    👆 💪 🔬 <abbr title="A regular expression, regex or regexp is a sequence of characters that define a search pattern for strings.">🥔 🧬</abbr> 👈 🔢 🔜 🏏:
    
    === "🐍 3️⃣.6️⃣ &amp; 🔛"
    
        ```Python hl_lines="11"
        {!> ../../../docs_src/query_params_str_validations/tutorial004.py!}
        ```
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Fri Mar 22 01:42:11 GMT 2024
    - 11.9K bytes
    - Viewed (0)
  9. docs/pt/docs/async.md

    ---
    
    Se você simplesmente não sabe, use apenas `def`.
    
    ---
    
    **Note**: Você pode misturar `def` e `async def` nas suas *funções de operação de rota* tanto quanto necessário e definir cada função usando a melhor opção para você. FastAPI irá fazer a coisa certa com elas.
    
    De qualquer forma, em ambos os casos acima, FastAPI irá trabalhar assincronamente e ser extremamente rápido.
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 22.2K bytes
    - Viewed (0)
  10. docs/en/docs/tutorial/security/oauth2-jwt.md

    Create a variable `ALGORITHM` with the algorithm used to sign the JWT token and set it to `"HS256"`.
    
    Create a variable for the expiration of the token.
    
    Define a Pydantic Model that will be used in the token endpoint for the response.
    
    Create a utility function to generate a new access token.
    
    === "Python 3.10+"
    
        ```Python hl_lines="6  12-14  28-30  78-86"
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 13K bytes
    - Viewed (0)
Back to top