Search Options

Results per page
Sort
Preferred Languages
Advance

Results 1 - 8 of 8 for Utilities (0.23 sec)

  1. docs/en/docs/reference/openapi/index.md

    # OpenAPI
    
    There are several utilities to handle OpenAPI.
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Wed Oct 18 12:36:40 GMT 2023
    - 158 bytes
    - Viewed (0)
  2. docs/en/docs/tutorial/security/first-steps.md

        All the security utilities that integrate with OpenAPI (and the automatic API docs) inherit from `SecurityBase`, that's how **FastAPI** can know how to integrate them in OpenAPI.
    
    ## What it does
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Wed Mar 13 19:02:19 GMT 2024
    - 8.9K bytes
    - Viewed (0)
  3. docs/en/docs/reference/openapi/docs.md

    # OpenAPI `docs`
    
    Utilities to handle OpenAPI automatic UI documentation, including Swagger UI (by default at `/docs`) and ReDoc (by default at `/redoc`).
    
    ::: fastapi.openapi.docs.get_swagger_ui_html
    
    ::: fastapi.openapi.docs.get_redoc_html
    
    ::: fastapi.openapi.docs.get_swagger_ui_oauth2_redirect_html
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Wed Oct 18 12:36:40 GMT 2023
    - 360 bytes
    - Viewed (0)
  4. docs/en/docs/tutorial/dependencies/dependencies-in-path-operation-decorators.md

    !!! info
        In this example we use invented custom headers `X-Key` and `X-Token`.
    
        But in real cases, when implementing security, you would get more benefits from using the integrated [Security utilities (the next chapter)](../security/index.md){.internal-link target=_blank}.
    
    ## Dependencies errors and return values
    
    You can use the same dependency *functions* you use normally.
    
    ### Dependency requirements
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Tue Oct 17 05:59:11 GMT 2023
    - 4.1K bytes
    - Viewed (0)
  5. docs/en/docs/tutorial/security/index.md

        The most complex problem is building an authentication/authorization provider like those, but **FastAPI** gives you the tools to do it easily, while doing the heavy lifting for you.
    
    ## **FastAPI** utilities
    
    FastAPI provides several tools for each of these security schemes in the `fastapi.security` module that simplify using these security mechanisms.
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Sat Jun 24 14:47:15 GMT 2023
    - 4.3K bytes
    - Viewed (0)
  6. docs/en/docs/advanced/websockets.md

    ### In production
    
    In your production system, you probably have a frontend created with a modern framework like React, Vue.js or Angular.
    
    And to communicate using WebSockets with your backend you would probably use your frontend's utilities.
    
    Or you might have a native mobile application that communicates with your WebSocket backend directly, in native code.
    
    Or you might have any other way to communicate with the WebSocket endpoint.
    
    ---
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu May 02 22:37:31 GMT 2024
    - 6.2K bytes
    - Viewed (0)
  7. docs/en/docs/advanced/templates.md

    # Templates
    
    You can use any template engine you want with **FastAPI**.
    
    A common choice is Jinja2, the same one used by Flask and other tools.
    
    There are utilities to configure it easily that you can use directly in your **FastAPI** application (provided by Starlette).
    
    ## Install dependencies
    
    Install `jinja2`:
    
    <div class="termy">
    
    ```console
    $ pip install jinja2
    
    ---> 100%
    ```
    
    </div>
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu Jan 11 22:25:37 GMT 2024
    - 3.2K bytes
    - Viewed (0)
  8. docs/en/docs/tutorial/handling-errors.md

    ```
    
    ## Install custom exception handlers
    
    You can add custom exception handlers with <a href="https://www.starlette.io/exceptions/" class="external-link" target="_blank">the same exception utilities from Starlette</a>.
    
    Let's say you have a custom exception `UnicornException` that you (or a library you use) might `raise`.
    
    And you want to handle this exception globally with FastAPI.
    
    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)
Back to top