Search Options

Results per page
Sort
Preferred Languages
Advance

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

  1. docs/en/docs/advanced/generate-clients.md

    <img src="/img/tutorial/generate-clients/image01.png">
    
    You can see those schemas because they were declared with the models in the app.
    
    That information is available in the app's **OpenAPI schema**, and then shown in the API docs (by Swagger UI).
    
    And that same information from the models that is included in OpenAPI is what can be used to **generate the client code**.
    
    ### Generate a TypeScript Client
    
    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)
  2. docs/en/docs/tutorial/metadata.md

    ```Python hl_lines="3-16  18"
    {!../../../docs_src/metadata/tutorial004.py!}
    ```
    
    Notice that you can use Markdown inside of the descriptions, for example "login" will be shown in bold (**login**) and "fancy" will be shown in italics (_fancy_).
    
    !!! tip
        You don't have to add metadata for all the tags that you use.
    
    ### Use your tags
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Sun Mar 31 23:52:53 GMT 2024
    - 5.8K bytes
    - Viewed (0)
  3. docs/en/docs/how-to/general.md

    ## Documentation Response description - OpenAPI
    
    To define the description of the response, shown in the docs UI, read the docs for [Tutorial - Path Operation Configurations - Response description](../tutorial/path-operation-configuration.md#response-description){.internal-link target=_blank}.
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Sat Aug 19 19:54:04 GMT 2023
    - 2.3K bytes
    - Viewed (0)
  4. docs/en/docs/release-notes.md

    * 🐛 Fix edge case with repeated aliases names not shown in OpenAPI. PR [#2351](https://github.com/tiangolo/fastapi/pull/2351) by [@klaa97](https://github.com/klaa97).
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Fri May 03 23:25:42 GMT 2024
    - 388.1K bytes
    - Viewed (1)
  5. 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 May 05 07:19:11 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 11.6K bytes
    - Viewed (0)
  6. 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 May 05 07:19:11 GMT 2024
    - Last Modified: Tue Apr 02 02:48:51 GMT 2024
    - 10.1K bytes
    - Viewed (0)
  7. 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 May 05 07:19:11 GMT 2024
    - Last Modified: Sat Aug 19 19:54:04 GMT 2023
    - 3.2K bytes
    - Viewed (0)
  8. 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 May 05 07:19:11 GMT 2024
    - Last Modified: Tue Apr 02 02:48:51 GMT 2024
    - 172.2K bytes
    - Viewed (0)
  9. 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 May 05 07:19:11 GMT 2024
    - Last Modified: Thu Jan 11 16:31:18 GMT 2024
    - 8.8K bytes
    - Viewed (0)
  10. 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 May 05 07:19:11 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 1.6K bytes
    - Viewed (0)
Back to top