st_swagger_ui

Streamlit component for embedding Swagger UI to display OpenAPI/Swagger specifications.

Features

• Display OpenAPI/Swagger specifications from URL or local file
• Configurable operation expansion (doc_expansion)
• Enable/disable "Try it out" functionality (try_it_out_enabled)
• Show/hide operation IDs (display_operation_id)
• Control model rendering (default_model_rendering)
• Custom CSS overrides for reduced indentation

Installation

uv add st_swagger_ui

or

pip install st_swagger_ui

Usage

Basic Usage

import streamlit as st
from st_swagger_ui import st_swagger_ui

# Load from URL
st_swagger_ui(url="https://petstore.swagger.io/v2/swagger.json")

Load from Local File

import json

with open("openapi.json") as f:
    spec = json.load(f)

st_swagger_ui(spec=spec)

Configuration Options

st_swagger_ui(
    url="https://petstore.swagger.io/v2/swagger.json",
    doc_expansion="list",           # "list" | "full" | "none"
    try_it_out_enabled=True,        # True | False | None
    display_operation_id=False,     # True | False | None
    default_model_rendering="example",  # "example" | "model" | None
)

Parameters

Note: Either url or spec must be provided (mutually exclusive).

Examples

Full Expansion with Model View

st_swagger_ui(
    url="https://petstore.swagger.io/v2/swagger.json",
    doc_expansion="full",
    default_model_rendering="model"
)

Read-Only Mode (No "Try it out")

st_swagger_ui(
    url="https://api.example.com/openapi.json",
    try_it_out_enabled=False,
    display_operation_id=True
)

Load from FastAPI App

from fastapi import FastAPI
import fastapi.openapi.utils

app = FastAPI()

spec = fastapi.openapi.utils.get_openapi(
    title="My API",
    version="1.0.0",
    openapi_version="3.0.0",
    routes=app.routes,
)

st_swagger_ui(spec=spec, doc_expansion="list")

License

MIT