Search Options

Results per page
Sort
Preferred Languages
Advance

Results 1 - 10 of 24 for define (0.2 sec)

  1. docs/en/docs/tutorial/first-steps.md

    #### API "schema"
    
    In this case, <a href="https://github.com/OAI/OpenAPI-Specification" class="external-link" target="_blank">OpenAPI</a> is a specification that dictates how to define a schema of your API.
    
    This schema definition includes your API paths, the possible parameters they take, etc.
    
    #### Data "schema"
    
    The term "schema" might also refer to the shape of some data, like a JSON content.
    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)
  2. 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)
  3. docs/en/docs/advanced/generate-clients.md

        ```
    
    === "Python 3.8+"
    
        ```Python hl_lines="9-11  14-15  18  19  23"
        {!> ../../../docs_src/generate_clients/tutorial001.py!}
        ```
    
    Notice that the *path operations* define the models they use for request payload and response payload, using the models `Item` and `ResponseMessage`.
    
    ### API Docs
    
    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)
  4. docs/en/docs/python-types.md

    If you can use the **latest versions of Python**, use the examples for the latest version, those will have the **best and simplest syntax**, for example, "**Python 3.10+**".
    
    #### List
    
    For example, let's define a variable to be a `list` of `str`.
    
    === "Python 3.9+"
    
        Declare the variable, with the same colon (`:`) syntax.
    
        As the type, put `list`.
    
    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)
  5. docs/en/docs/tutorial/response-model.md

    === "Python 3.8+"
    
        ```Python hl_lines="31  37"
        {!> ../../../docs_src/response_model/tutorial006.py!}
        ```
    
    ## Recap
    
    Use the *path operation decorator's* parameter `response_model` to define response models and especially to ensure private data is filtered out.
    
    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)
  6. fastapi/encoders.py

                if it should exclude from the output the fields that had the same default
                value, even when they were explicitly set.
                """
            ),
        ] = False,
        exclude_none: Annotated[
            bool,
            Doc(
                """
                Pydantic's `exclude_none` parameter, passed to Pydantic models to define
    Python
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu Apr 18 21:56:59 GMT 2024
    - 10.8K bytes
    - Viewed (0)
  7. docs/en/docs/tutorial/dependencies/index.md

    * API usage monitoring systems
    * response data injection systems
    * etc.
    
    ## Simple and Powerful
    
    Although the hierarchical dependency injection system is very simple to define and use, it's still very powerful.
    
    You can define dependencies that in turn can define dependencies themselves.
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 11.6K bytes
    - Viewed (0)
  8. 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)
  9. docs/en/docs/deployment/concepts.md

    * **Cloud services** that handle this for you
        * The cloud service will probably **handle replication for you**. It would possibly let you define **a process to run**, or a **container image** to use, in any case, it would most probably be **a single Uvicorn process**, and the cloud service would be in charge of replicating it.
    
    !!! tip
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu May 02 22:37:31 GMT 2024
    - 18K bytes
    - Viewed (0)
  10. docs/en/docs/advanced/custom-response.md

    ```Python hl_lines="2  7"
    {!../../../docs_src/custom_response/tutorial001b.py!}
    ```
    
    !!! info
        The parameter `response_class` will also be used to define the "media type" of the response.
    
        In this case, the HTTP header `Content-Type` will be set to `application/json`.
    
        And it will be documented as such in OpenAPI.
    
    !!! tip
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 11.7K bytes
    - Viewed (0)
Back to top