Search Options

Results per page
Sort
Preferred Languages
Advance

Results 1 - 10 of 14 for smDown (0.23 sec)

  1. docs/en/docs/advanced/additional-responses.md

    ```Python hl_lines="20-31"
    {!../../../docs_src/additional_responses/tutorial003.py!}
    ```
    
    It will all be combined and included in your OpenAPI, and shown in the API docs:
    
    <img src="/img/tutorial/additional-responses/image01.png">
    
    ## Combine predefined responses and custom ones
    
    Plain Text
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Thu Jan 11 16:31:18 GMT 2024
    - 8.8K bytes
    - Viewed (0)
  2. docs/en/docs/tutorial/sql-databases.md

    === "Python 3.8+"
    
        ```Python
        {!> ../../../docs_src/sql_databases/sql_app/main.py!}
        ```
    
    ## Check it
    
    You can copy this code and use it as is.
    
    !!! info
    
        In fact, the code shown here is part of the tests. As most of the code in these docs.
    
    Then you can run it with Uvicorn:
    
    
    <div class="termy">
    
    ```console
    $ uvicorn sql_app.main:app --reload
    
    Plain Text
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 29.6K bytes
    - Viewed (0)
  3. fastapi/openapi/docs.py

                `/openapi.json`.
                """
            ),
        ],
        title: Annotated[
            str,
            Doc(
                """
                The HTML `<title>` content, normally shown in the browser tab.
                """
            ),
        ],
        swagger_js_url: Annotated[
            str,
            Doc(
                """
                The URL to use to load the Swagger UI JavaScript.
    
    Python
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Tue Apr 02 02:48:51 GMT 2024
    - 10.1K bytes
    - Viewed (0)
  4. docs/en/docs/how-to/extending-openapi.md

    * `title`: The OpenAPI title, shown in the docs.
    * `version`: The version of your API, e.g. `2.5.0`.
    * `openapi_version`: The version of the OpenAPI specification used. By default, the latest: `3.1.0`.
    * `summary`: A short summary of the API.
    * `description`: The description of your API, this can include markdown and will be shown in the docs.
    Plain Text
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Sat Aug 19 19:54:04 GMT 2023
    - 3.2K bytes
    - Viewed (0)
  5. fastapi/applications.py

                    * `@app.get("/users/", tags=["users"])`
                    * `@app.get("/items/", tags=["items"])`
    
                    The order of the tags can be used to specify the order shown in
                    tools like Swagger UI, used in the automatic path `/docs`.
    
                    It's not required to specify all the tags used.
    
    Python
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Tue Apr 02 02:48:51 GMT 2024
    - 172.2K bytes
    - Viewed (0)
  6. docs/en/docs/reference/security/index.md

    There are multiple tools that you can use to create those dependables, and they get integrated into OpenAPI so they are shown in the automatic docs UI, they can be used by automatically generated clients and SDKs, etc.
    
    You can import them from `fastapi.security`:
    
    ```python
    from fastapi.security import (
        APIKeyCookie,
        APIKeyHeader,
    Plain Text
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 1.6K bytes
    - Viewed (0)
  7. fastapi/routing.py

            ] = Default(JSONResponse),
            responses: Annotated[
                Optional[Dict[Union[int, str], Dict[str, Any]]],
                Doc(
                    """
                    Additional responses to be shown in OpenAPI.
    
                    It will be added to the generated OpenAPI (e.g. visible at `/docs`).
    
                    Read more about it in the
    Python
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Tue Apr 02 02:48:51 GMT 2024
    - 170.1K bytes
    - Viewed (0)
  8. docs/en/docs/tutorial/body.md

    ## Automatic docs
    
    The JSON Schemas of your models will be part of your OpenAPI generated schema, and will be shown in the interactive API docs:
    
    <img src="/img/tutorial/body/image01.png">
    
    And will be also used in the API docs inside each *path operation* that needs them:
    
    <img src="/img/tutorial/body/image02.png">
    
    Plain Text
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Fri Mar 22 01:42:11 GMT 2024
    - 7.3K bytes
    - Viewed (0)
  9. docs/en/docs/tutorial/schema-extra-example.md

    Each specific example `dict` in the `examples` can contain:
    
    * `summary`: Short description for the example.
    * `description`: A long description that can contain Markdown text.
    * `value`: This is the actual example shown, e.g. a `dict`.
    * `externalValue`: alternative to `value`, a URL pointing to the example. Although this might not be supported by as many tools as `value`.
    
    You can use it like this:
    
    === "Python 3.10+"
    
    Plain Text
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 11.8K bytes
    - Viewed (0)
  10. docs/en/docs/tutorial/dependencies/index.md

    All these dependencies, while declaring their requirements, also add parameters, validations, etc. to your *path operations*.
    
    Plain Text
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 11.6K bytes
    - Viewed (0)
Back to top