Configure Swagger UI — JustAPI Docs

Basic Configuration

from justapi import JustAPIApp

app = JustAPIApp(
    docs_url="/docs",
    redoc_url="/redoc",
    swagger_ui_parameters={
        "docExpansion": "none",
        "filter": True,
        "tagsSorter": "alpha",
        "operationsSorter": "alpha",
    },
)

Common Options

Parameter	Type	Description
`docExpansion`	`str`	`"none"`, `"list"`, `"full"`
`filter`	`bool` or `str`	Enable search filter
`tagsSorter`	`str`	`"alpha"` for alphabetical
`operationsSorter`	`str`	`"alpha"` for alphabetical
`defaultModelsExpandDepth`	`int`	Model expansion depth
`defaultModelExpandDepth`	`int`	Individual model depth

Disable Docs in Production

import os

app = JustAPIApp(
    docs_url="/docs" if os.getenv("ENVIRONMENT") == "development" else None,
    redoc_url="/redoc" if os.getenv("ENVIRONMENT") == "development" else None,
)

Basic Configuration

Common Options

Disable Docs in Production

See Also