Search Options

Results per page
Sort
Preferred Languages
Advance

Results 1 - 10 of 107 for This (0.14 sec)

  1. fastapi/param_functions.py

                This doesn't affect `Path` parameters as the value is always required.
                The parameter is available only for compatibility.
                """
            ),
        ] = _Unset,
        alias: Annotated[
            Optional[str],
            Doc(
                """
                An alternative name for the parameter field.
    
                This will be used to extract the data and for the generated OpenAPI.
    Python
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu Apr 18 19:40:57 GMT 2024
    - 62.5K bytes
    - Viewed (0)
  2. docs/en/docs/tutorial/response-model.md

        {!> ../../../docs_src/response_model/tutorial003_01.py!}
        ```
    
    With this, we get tooling support, from editors and mypy as this code is correct in terms of types, but we also get the data filtering from FastAPI.
    
    How does this work? Let's check that out. 🤓
    
    ### Type Annotations and Tooling
    
    First let's see how editors, mypy and other tools would see this.
    
    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)
  3. docs/en/docs/advanced/dataclasses.md

    * data serialization
    * data documentation, etc.
    
    This works the same way as with Pydantic models. And it is actually achieved in the same way underneath, using Pydantic.
    
    !!! info
        Keep in mind that dataclasses can't do everything Pydantic models can do.
    
        So, you might still need to use Pydantic models.
    
        But if you have a bunch of dataclasses laying around, this is a nice trick to use them to power a web API using FastAPI. 🤓
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 4.1K bytes
    - Viewed (0)
  4. fastapi/security/oauth2.py

            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
        same *path operation*. And with this, you can access all the scopes required in
        all those dependencies in a single place.
    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)
  5. pdm_build.py

            "optional-dependencies", {}
        )
        # Get custom optional dependencies name to always include in this (non-slim) package
        include_optional_dependencies: List[str] = config.get(
            "include-optional-dependencies", []
        )
        # Override main [project] configs with custom configs for this package
        for key, value in project_config.items():
            metadata[key] = value
    Python
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Tue Apr 30 06:38:13 GMT 2024
    - 1.7K bytes
    - Viewed (0)
  6. docs/en/docs/advanced/behind-a-proxy.md

    <img src="/img/tutorial/behind-a-proxy/image02.png">
    
    Right as we wanted it. ✔️
    
    This is because FastAPI uses this `root_path` to create the default `server` in OpenAPI with the URL provided by `root_path`.
    
    ## Additional servers
    
    !!! warning
        This is a more advanced use case. Feel free to skip it.
    
    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)
  7. docs/en/docs/tutorial/path-params.md

    ```Python hl_lines="7"
    {!../../../docs_src/path_params/tutorial002.py!}
    ```
    
    In this case, `item_id` is declared to be an `int`.
    
    !!! check
        This will give you editor support inside of your function, with error checks, completion, etc.
    
    ## Data <abbr title="also known as: serialization, parsing, marshalling">conversion</abbr>
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Fri Mar 22 01:42:11 GMT 2024
    - 9.1K bytes
    - Viewed (0)
  8. docs/en/docs/alternatives.md

    !!! check "Inspired **FastAPI** to"
        Define extra validations for data types using the "default" value of model attributes. This improves editor support, and it was not available in Pydantic before.
    
    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)
  9. docs/en/docs/advanced/generate-clients.md

    If you generate a client for a FastAPI app using tags, it will normally also separate the client code based on the tags.
    
    This way you will be able to have things ordered and grouped correctly for the client code:
    
    <img src="/img/tutorial/generate-clients/image06.png">
    
    In this case you have:
    
    * `ItemsService`
    * `UsersService`
    
    ### Client Method Names
    
    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)
  10. 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"
    
    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)
Back to top