Search Options

Results per page
Sort
Preferred Languages
Advance

Results 1 - 10 of 126 for Will (0.16 sec)

  1. fastapi/security/http.py

        For example, in an HTTP Bearer token scheme, the client will send a header
        like:
    
        ```
        Authorization: Bearer deadbeef12346
        ```
    
        In this case:
    
        * `scheme` will have the value `"Bearer"`
        * `credentials` will have the value `"deadbeef12346"`
        """
    
        scheme: Annotated[
            str,
            Doc(
                """
    Python
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Fri Apr 19 15:29:38 GMT 2024
    - 13.2K bytes
    - Viewed (0)
  2. docs/en/docs/tutorial/response-model.md

        ```
    
    FastAPI will use this return type to:
    
    * **Validate** the returned data.
        * If the data is invalid (e.g. you are missing a field), it means that *your* app code is broken, not returning what it should, and it will return a server error instead of returning incorrect data. This way you and your clients can be certain that they will receive the data and the data shape expected.
    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/generate-clients.md

    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:
    
    <img src="/img/tutorial/generate-clients/image05.png">
    
    ## FastAPI App with Tags
    
    In many cases your FastAPI app will be bigger, and you will probably use tags to separate different groups of *path operations*.
    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. fastapi/param_functions.py

                """
                'Whitelist' validation step. The parameter field will be the single one
                allowed by the alias or set of aliases defined.
                """
            ),
        ] = None,
        serialization_alias: Annotated[
            Union[str, None],
            Doc(
                """
                'Blacklist' validation step. The vanilla parameter field will be the
    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)
  5. docs/en/docs/tutorial/path-params.md

    ### Create an `Enum` class
    
    Import `Enum` and create a sub-class that inherits from `str` and from `Enum`.
    
    By inheriting from `str` the API docs will be able to know that the values must be of type `string` and will be able to render correctly.
    
    Then create class attributes with fixed values, which will be the available valid values:
    
    ```Python hl_lines="1  6-9"
    {!../../../docs_src/path_params/tutorial005.py!}
    ```
    
    !!! info
    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)
  6. docs/en/docs/contributing.md

    <div class="termy">
    
    ```console
    $ python -m venv env
    ```
    
    </div>
    
    That will create a directory `./env/` with the Python binaries, and then you will be able to install packages for that local environment.
    
    ### Activate the environment
    
    Activate the new environment with:
    
    === "Linux, macOS"
    
        <div class="termy">
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu Jan 11 17:42:43 GMT 2024
    - 14.1K bytes
    - Viewed (0)
  7. docs/en/docs/tutorial/middleware.md

        If you have dependencies with `yield`, the exit code will run *after* the middleware.
    
        If there were any background tasks (documented later), they will run *after* all the middleware.
    
    ## Create a middleware
    
    To create a middleware you use the decorator `@app.middleware("http")` on top of a function.
    
    The middleware function receives:
    
    * The `request`.
    * A function `call_next` that will receive the `request` as a parameter.
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu Jan 11 16:31:18 GMT 2024
    - 2.9K bytes
    - Viewed (0)
  8. fastapi/security/oauth2.py

                    Security scheme name.
    
                    It will be included in the generated OpenAPI (e.g. visible at `/docs`).
                    """
                ),
            ] = None,
            description: Annotated[
                Optional[str],
                Doc(
                    """
                    Security scheme description.
    
                    It will be included in the generated OpenAPI (e.g. visible at `/docs`).
    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)
  9. docs/en/docs/advanced/behind-a-proxy.md

    ```JSON
    {
        "message": "Hello World",
        "root_path": "/api/v1"
    }
    ```
    
    So, it won't expect to be accessed at `http://127.0.0.1:8000/api/v1/app`.
    
    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)
  10. docs/en/docs/tutorial/body-fields.md

    ## Add extra information
    
    You can declare extra information in `Field`, `Query`, `Body`, etc. And it will be included in the generated JSON Schema.
    
    You will learn more about adding extra information later in the docs, when learning to declare examples.
    
    !!! warning
        Extra keys passed to `Field` will also be present in the resulting OpenAPI schema for your application.
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Tue Oct 17 05:59:11 GMT 2023
    - 3.6K bytes
    - Viewed (0)
Back to top