Search Options

Results per page
Sort
Preferred Languages
Advance

Results 1 - 10 of 30 for define (0.16 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. fastapi/security/oauth2.py

                    )
                else:
                    return None  # pragma: nocover
            return param
    
    
    class SecurityScopes:
        """
        This is a special class that you can define in a parameter in a dependency to
        obtain the OAuth2 scopes required by all the dependencies in the same chain.
    
        This way, multiple dependencies can have different scopes, even when used in the
    Python
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Tue Apr 02 02:48:51 GMT 2024
    - 21.1K bytes
    - Viewed (1)
  6. 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)
  7. 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)
  8. 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)
  9. 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)
  10. docs/en/docs/tutorial/request-files.md

    # Request Files
    
    You can define files to be uploaded by the client using `File`.
    
    !!! info
        To receive uploaded files, first install <a href="https://github.com/Kludex/python-multipart" class="external-link" target="_blank">`python-multipart`</a>.
    
        E.g. `pip install python-multipart`.
    
        This is because uploaded files are sent as "form data".
    
    ## Import `File`
    
    Import `File` and `UploadFile` from `fastapi`:
    
    === "Python 3.9+"
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Wed Mar 13 19:02:19 GMT 2024
    - 10.2K bytes
    - Viewed (0)
Back to top