/ justapi / docs_site / src / content / docs / how-to / configure-swagger-ui.md
swadhinbiswas docs: create 23 new advanced guide and how-to recipe pages · 7/25/2026
cfda6b2
51 lines · 1.4 KB
Raw Download

title: Configure Swagger UI
description: Customize the Swagger UI appearance and behavior in JustAPI.
keywords: [JustAPI, Swagger UI, documentation, OpenAPI, customization]

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,
)

See Also