feat: add base route

Author: felipementel

src/adapters/inbound/http/routes/root.py

@@ -0,0 +1,100 @@
+from fastapi import APIRouter, Request
+from fastapi.openapi.docs import get_scalar_api_reference
+from fastapi.responses import HTMLResponse
+
+router = APIRouter(include_in_schema=False)
+
+_ROOT_HTML_TEMPLATE = """\
+<!DOCTYPE html>
+<html lang="pt-BR">
+<head>
+  <meta charset="UTF-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>API Details</title>
+  <style>
+    *, *::before, *::after {{ box-sizing: border-box; margin: 0; padding: 0; }}
+    body {{
+      font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, sans-serif;
+      background: #f5f5f5;
+      display: flex;
+      justify-content: center;
+      align-items: center;
+      min-height: 100vh;
+    }}
+    .card {{
+      background: #fff;
+      border-radius: 12px;
+      padding: 2rem 2.5rem;
+      box-shadow: 0 4px 24px rgba(0,0,0,.08);
+      min-width: 320px;
+    }}
+    h1 {{ font-size: 1.4rem; color: #1a1a1a; margin-bottom: .25rem; }}
+    .version {{ font-size: .8rem; color: #888; margin-bottom: 1.5rem; }}
+    .section {{ margin-bottom: 1.25rem; }}
+    .section-title {{
+      font-size: .7rem;
+      font-weight: 600;
+      text-transform: uppercase;
+      letter-spacing: .06em;
+      color: #999;
+      margin-bottom: .5rem;
+    }}
+    ul {{ list-style: none; }}
+    li {{ margin-bottom: .35rem; }}
+    a {{
+      display: inline-flex;
+      align-items: center;
+      gap: .4rem;
+      color: #2563eb;
+      text-decoration: none;
+      font-size: .9rem;
+    }}
+    a:hover {{ text-decoration: underline; }}
+    .badge {{
+      font-size: .65rem;
+      background: #e0edff;
+      color: #1d4ed8;
+      border-radius: 4px;
+      padding: 1px 5px;
+      font-weight: 600;
+    }}
+  </style>
+</head>
+<body>
+  <div class="card">
+    <h1>Usuarios API Python</h1>
+    <p class="version">v{version}</p>
+
+    <div class="section">
+      <div class="section-title">Documentação</div>
+      <ul>
+        <li><a href="/scalar">Scalar UI <span class="badge">interactive</span></a></li>
+        <li><a href="/docs">Swagger UI</a></li>
+        <li><a href="/openapi.json">OpenAPI Spec <span class="badge">JSON</span></a></li>
+      </ul>
+    </div>
+
+    <div class="section">
+      <div class="section-title">Health Probes</div>
+      <ul>
+        <li><a href="/health/live">GET /health/live</a></li>
+        <li><a href="/health/ready">GET /health/ready</a></li>
+      </ul>
+    </div>
+  </div>
+</body>
+</html>"""
+
+
+@router.get("/", response_class=HTMLResponse)
+async def root(request: Request) -> HTMLResponse:
+    version = getattr(request.app, "version", "0.1.0")
+    return HTMLResponse(content=_ROOT_HTML_TEMPLATE.format(version=version))
+
+
+@router.get("/scalar", response_class=HTMLResponse)
+async def scalar_ui(request: Request) -> HTMLResponse:
+    return get_scalar_api_reference(
+        openapi_url=str(request.app.openapi_url),
+        title=request.app.title,
+    )

src/main.py

@@ -2,6 +2,7 @@
 import uvicorn
 
 from adapters.inbound.http.routes.health import router as health_router
+from adapters.inbound.http.routes.root import router as root_router
 from adapters.inbound.http.routes.users import router as users_router
 from adapters.outbound.repositories.in_memory_user_repository import (
     InMemoryUserRepository,
@@ -21,6 +22,7 @@ def create_app(user_service: UserService | None = None) -> FastAPI:
         description="CRUD de usuarios com persistencia em memoria.",
     )
     app.state.user_service = user_service or build_user_service()
+    app.include_router(root_router)
     app.include_router(health_router)
     app.include_router(users_router)
     return app