quaik8/sdb2-backend
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: Update API documentation endpoints and enhance application metadata for SBD v2
All checks were successful
Backend CI / lint (push) Successful in 9m22s
Details
Backend CI / test (push) Successful in 3m54s
Details

Browse Source
This commit is contained in:
JSC
2025-08-13 13:56:01 +02:00
parent bee1076239
commit 87d6e6ed67
4 changed files with 72 additions and 75 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
app/api/v1/main.py
View File

@@ -11,14 +11,14 @@ router = APIRouter()
logger = get_logger(__name__)
@router.get("/")
@router.get("/health")
def health() -> HealthResponse:
"""Health check endpoint."""
logger.info("Health check endpoint accessed")
return HealthResponse(status="healthy")
@router.get("/scalar-docs", response_class=HTMLResponse)
@router.get("/docs/scalar", response_class=HTMLResponse)
def scalar_docs() -> HTMLResponse:
"""Serve the API documentation using Scalar."""
return """
@@ -39,8 +39,8 @@ def scalar_docs() -> HTMLResponse:
"""
@router.get("/rapidoc-docs", response_class=HTMLResponse)
async def rapidoc() -> HTMLResponse:
@router.get("/docs/rapidoc", response_class=HTMLResponse)
async def rapidoc_docs() -> HTMLResponse:
"""Serve the API documentation using Rapidoc."""
return """
<!doctype html>
@@ -61,7 +61,7 @@ async def rapidoc() -> HTMLResponse:
"""
@router.get("/elements-docs", response_class=HTMLResponse)
@router.get("/docs/elements", response_class=HTMLResponse)
async def elements_docs() -> HTMLResponse:
"""Serve the API documentation using Stoplight Elements."""
return """

9
app/main.py
View File

@@ -59,12 +59,9 @@ async def lifespan(_app: FastAPI) -> AsyncGenerator[None, None]:
def create_app() -> FastAPI:
"""Create and configure the FastAPI application."""
app = FastAPI(
title="Soundboard API",
description=(
"API for the Soundboard application with authentication, "
"sound management, and real-time features"
),
version="1.0.0",
title="SBD v2 API",
description=("API for the SBD v2 application"),
version="2.0.0",
lifespan=lifespan,
# Configure docs URLs for reverse proxy setup
docs_url="/api/docs", # Swagger UI at /api/docs