Search Options

Results per page
Sort
Preferred Languages
Advance

Results 1 - 10 of 65 for interfaces (0.17 sec)

  1. docs/en/docs/alternatives.md

        And integrate standards-based user interface tools:
    
        * <a href="https://github.com/swagger-api/swagger-ui" class="external-link" target="_blank">Swagger UI</a>
        * <a href="https://github.com/Rebilly/ReDoc" class="external-link" target="_blank">ReDoc</a>
    
        These two were chosen for being fairly popular and stable, but doing a quick search, you could find dozens of alternative user interfaces for OpenAPI (that you can use with **FastAPI**).
    Plain Text
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 23.2K bytes
    - Viewed (0)
  2. docs/en/docs/how-to/general.md

    ## OpenAPI Docs URLs
    
    Plain Text
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Sat Aug 19 19:54:04 GMT 2023
    - 2.3K bytes
    - Viewed (0)
  3. docs/en/docs/how-to/conditional-openapi.md

    If you needed to, you could use settings and environment variables to configure OpenAPI conditionally depending on the environment, and even disable it entirely.
    
    ## About security, APIs, and docs
    
    Hiding your documentation user interfaces in production *shouldn't* be the way to protect your API.
    
    That doesn't add any extra security to your API, the *path operations* will still be available where they are.
    
    Plain Text
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Sat Aug 19 19:54:04 GMT 2023
    - 2.3K bytes
    - Viewed (0)
  4. docs/en/docs/tutorial/metadata.md

    {!../../../docs_src/metadata/tutorial002.py!}
    ```
    
    If you want to disable the OpenAPI schema completely you can set `openapi_url=None`, that will also disable the documentation user interfaces that use it.
    
    ## Docs URLs
    
    You can configure the two documentation user interfaces included:
    
    * **Swagger UI**: served at `/docs`.
        * You can set its URL with the parameter `docs_url`.
        * You can disable it by setting `docs_url=None`.
    Plain Text
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Sun Mar 31 23:52:53 GMT 2024
    - 5.8K bytes
    - Viewed (0)
  5. docs/en/docs/advanced/sub-applications.md

    <img src="/img/tutorial/sub-applications/image02.png">
    
    If you try interacting with any of the two user interfaces, they will work correctly, because the browser will be able to talk to each specific app or sub-app.
    
    ### Technical Details: `root_path`
    
    Plain Text
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 2.9K bytes
    - Viewed (0)
  6. fastapi/param_functions.py

            Doc(
                """
                OpenAPI-specific examples.
    
                It will be added to the generated OpenAPI (e.g. visible at `/docs`).
    
                Swagger UI (that provides the `/docs` interface) has better support for the
                OpenAPI-specific examples than the JSON Schema `examples`, that's the main
                use case for this.
    
                Read more about it in the
    Python
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Thu Apr 18 19:40:57 GMT 2024
    - 62.5K bytes
    - Viewed (0)
  7. docs/en/docs/advanced/dataclasses.md

    ```Python hl_lines="1  7-13  19"
    {!../../../docs_src/dataclasses/tutorial002.py!}
    ```
    
    The dataclass will be automatically converted to a Pydantic dataclass.
    
    This way, its schema will show up in the API docs user interface:
    
    <img src="/img/tutorial/dataclasses/image01.png">
    
    ## Dataclasses in Nested Data Structures
    
    You can also combine `dataclasses` with other type annotations to make nested data structures.
    
    Plain Text
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 4.1K bytes
    - Viewed (0)
  8. docs/en/docs/how-to/graphql.md

    !!! tip
    Plain Text
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Sat Aug 19 19:54:04 GMT 2023
    - 3.4K bytes
    - Viewed (0)
  9. docs/en/docs/advanced/middleware.md

    In this section we'll see how to use other middlewares.
    
    ## Adding ASGI middlewares
    
    As **FastAPI** is based on Starlette and implements the <abbr title="Asynchronous Server Gateway Interface">ASGI</abbr> specification, you can use any ASGI middleware.
    
    A middleware doesn't have to be made for FastAPI or Starlette to work, as long as it follows the ASGI spec.
    
    Plain Text
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Fri Mar 10 18:27:10 GMT 2023
    - 4K bytes
    - Viewed (0)
  10. docs/it/docs/index.md

    <a href="https://typer.tiangolo.com" target="_blank"><img src="https://typer.tiangolo.com/img/logo-margin/logo-margin-vector.svg" style="width: 20%;"></a>
    
    Se stai sviluppando un'app <abbr title="Command Line Interface (interfaccia della riga di comando)">CLI</abbr> da usare nel terminale invece che una web API, ti consigliamo <a href="https://typer.tiangolo.com/" class="external-link" target="_blank">**Typer**</a>.
    
    Plain Text
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Thu Apr 18 23:58:47 GMT 2024
    - 19.3K bytes
    - Viewed (0)
Back to top