Search Options

Results per page
Sort
Preferred Languages
Advance

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

  1. 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 May 05 07:19:11 GMT 2024
    - Last Modified: Sun Mar 31 23:52:53 GMT 2024
    - 5.8K bytes
    - Viewed (0)
  2. docs/en/docs/how-to/general.md

    ## OpenAPI Docs URLs
    
    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)
  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 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/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 May 05 07:19:11 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 2.9K bytes
    - Viewed (0)
  5. docs/fa/docs/tutorial/security/index.md

    فریم ورک **FastAPI** بر اساس **OpenAPI** است.
    
    این خاصیت، امکان دارد تا چندین رابط مستندات تعاملی خودکار(automatic interactive documentation interfaces)، تولید کد و غیره وجود داشته باشد.
    
    مشخصه OpenAPI روشی برای تعریف چندین "schemes" دارد.
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Tue Jan 23 15:06:11 GMT 2024
    - 7.6K bytes
    - Viewed (0)
  6. 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 May 05 07:19:11 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 23.2K bytes
    - Viewed (0)
  7. docs/es/docs/index.md

        * Objetos `datetime`.
        * Objetos `UUID`.
        * Modelos de bases de datos.
        * ...y muchos más.
    * Documentación automática e interactiva incluyendo 2 interfaces de usuario alternativas:
        * Swagger UI.
        * ReDoc.
    
    ---
    
    Volviendo al ejemplo de código anterior, **FastAPI** va a:
    
    * Validar que existe un `item_id` en el path para requests usando `GET` y `PUT`.
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Mon Apr 29 05:18:04 GMT 2024
    - 19K bytes
    - Viewed (0)
  8. docs/en/docs/tutorial/bigger-applications.md

        ---
    
        The `APIRouter`s are not "mounted", they are not isolated from the rest of the application.
    
        This is because we want to include their *path operations* in the OpenAPI schema and the user interfaces.
    
        As we cannot just isolate them and "mount" them independently of the rest, the *path operations* are "cloned" (re-created), not included directly.
    
    ## Check the automatic API docs
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 18.6K bytes
    - Viewed (0)
  9. docs/en/docs/python-types.md

        * Generating **automatic errors** returned to the client when the data is invalid.
    * **Document** the API using OpenAPI:
        * which is then used by the automatic interactive documentation user interfaces.
    
    This might all sound abstract. Don't worry. You'll see all this in action in the [Tutorial - User Guide](tutorial/index.md){.internal-link target=_blank}.
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 17K bytes
    - Viewed (0)
  10. docs/pt/docs/tutorial/response-status-code.md

    Dessa forma:
    
    * Este código de status será retornado na resposta.
    * Será documentado como tal no esquema OpenAPI (e, portanto, nas interfaces do usuário):
    
    <img src="/img/tutorial/response-status-code/image01.png">
    
    !!! note "Nota"
        Alguns códigos de resposta (consulte a próxima seção) indicam que a resposta não possui um corpo.
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Mon Oct 31 16:22:07 GMT 2022
    - 4.3K bytes
    - Viewed (0)
Back to top