Views

redoc_html(request) async

Redoc UI.

Parameters:

Name	Type	Description	Default
request	Request	current request.	required

Returns:

Type	Description
HTMLResponse	rendered redoc UI.

Source code in hestia/web/api/docs/views.py

@router.get("/redoc", include_in_schema=False)
async def redoc_html(request: Request) -> HTMLResponse:
    """
    Redoc UI.

    :param request: current request.
    :return: rendered redoc UI.
    """
    title = request.app.title
    return get_redoc_html(
        openapi_url=request.app.openapi_url,
        title=f"{title} - ReDoc",
        redoc_js_url="/static/docs/redoc.standalone.js",
    )

swagger_ui_html(request) async

Swagger UI.

Parameters:

Name	Type	Description	Default
request	Request	current request.	required

Returns:

Type	Description
HTMLResponse	rendered swagger UI.

Source code in hestia/web/api/docs/views.py

@router.get("/docs", include_in_schema=False)
async def swagger_ui_html(request: Request) -> HTMLResponse:
    """
    Swagger UI.

    :param request: current request.
    :return: rendered swagger UI.
    """
    title = request.app.title
    return get_swagger_ui_html(
        openapi_url=request.app.openapi_url,
        title=f"{title} - Swagger UI",
        oauth2_redirect_url=request.url_for("swagger_ui_redirect"),
        swagger_js_url="/static/docs/swagger-ui-bundle.js",
        swagger_css_url="/static/docs/swagger-ui.css",
    )

swagger_ui_redirect() async

Redirect to swagger.

Returns:

Type	Description
HTMLResponse	redirect.

Source code in hestia/web/api/docs/views.py

@router.get("/swagger-redirect", include_in_schema=False)
async def swagger_ui_redirect() -> HTMLResponse:
    """
    Redirect to swagger.

    :return: redirect.
    """
    return get_swagger_ui_oauth2_redirect_html()