[SAM-260011]: feat: restructure FastAPI application and implement new routing

Author: Heisenberg208

src/sample/__main__.py

@@ -1,72 +1,12 @@
-import logging
-from contextlib import asynccontextmanager
-from pathlib import Path
-
-from fastapi import FastAPI, Request
-from fastapi.responses import HTMLResponse
-from fastapi.staticfiles import StaticFiles
-from fastapi.templating import Jinja2Templates
-from sample.db.connection import connect_db
 from sample.utils.constants import PORT
 
-from . import __version__
-
-
-@asynccontextmanager
-async def lifespan(app: FastAPI):
-    # Startup logic
-    print("🏷️ Sample version:", __version__)
-    logging.info("Starting FastAPI server...")
-    try:
-        db = connect_db()
-        print(f"Using database: {db.name}")
-    except Exception as e:
-        logging.error(f"⚠️ Database connection failed: {e}")
-    print("App is ready.")
-
-    yield  # <-- control passes to request handling
-
-    # Shutdown logic
-    logging.info("Shutting down FastAPI server...")
-    # If you want to close DB connections, do it here
-
-
-# Create FastAPI app with lifespan handler
-app = FastAPI(lifespan=lifespan)
-
-# Mount assets and pages
-app.mount("/static", StaticFiles(directory="assets"), name="static")
-
-# Point Jinja2 to your templates directory
-templates = Jinja2Templates(
-    directory=str(Path(__file__).resolve().parents[2] / "templates")
-)
-
-
-@app.get("/", response_class=HTMLResponse)
-async def index(request: Request):
-    """Serve the main index.html at root."""
-    return templates.TemplateResponse("index.html", {"request": request})
-
-
-@app.get("/faq", response_class=HTMLResponse)
-async def faq(request: Request):
-    return templates.TemplateResponse("faq.html", {"request": request})
-
-
-templates = Jinja2Templates(directory="templates")
-
-
-@app.get("/{full_path:path}", response_class=HTMLResponse)
-async def catch_all(request: Request, full_path: str):
-    return templates.TemplateResponse("404.html", {"request": request}, status_code=404)
-
 
 def main():
     """Entry point for CLI dev command."""
-    import uvicorn
+    from sample.api.main import start
 
-    uvicorn.run("sample.__main__:app", host="127.0.0.1", port=PORT, reload=True)
+    print(f"🚀 Starting Sample app on port {PORT}...\n")
+    start()
 
 
 if __name__ == "__main__":

src/sample/api/fast_api.py

@@ -0,0 +1,52 @@
+import logging
+from contextlib import asynccontextmanager
+from pathlib import Path
+
+from fastapi import FastAPI
+from fastapi.staticfiles import StaticFiles
+from fastapi.templating import Jinja2Templates
+from sample import __version__
+from sample.api.routes import api_router
+from sample.api.web_page import web_router
+from sample.db.connection import connect_db
+from sample.utils.constants import PORT
+
+
+@asynccontextmanager
+async def lifespan(app: FastAPI):
+    print("🏷️ Sample version:", __version__)
+    logging.info("Starting FastAPI server...")
+    try:
+        db = connect_db()
+        print(f"Using database: {db.name}")
+    except Exception as e:
+        logging.error(f"⚠️ Database connection failed: {e}")
+
+    yield
+
+    logging.info("Shutting down FastAPI server...")
+
+
+app = FastAPI(
+    title="Sample API",
+    version=__version__,
+    lifespan=lifespan,
+)
+
+# Static
+app.mount("/static", StaticFiles(directory="assets"), name="static")
+
+# Templates
+templates = Jinja2Templates(
+    directory=str(Path(__file__).resolve().parent / "templates")
+)
+
+
+app.include_router(web_router)
+app.include_router(api_router)
+
+
+def start():
+    import uvicorn
+
+    uvicorn.run("sample.api.main:app", host="127.0.0.1", port=PORT, reload=True)

src/sample/api/main.py

@@ -0,0 +1,87 @@
+from fastapi import APIRouter, HTTPException, Request
+from pydantic import BaseModel
+from sample.utils.constants import API_PREFIX, GREETING
+from sample.utils.helper import normalize_name
+from starlette.responses import HTMLResponse, JSONResponse
+
+api_router = APIRouter(prefix=API_PREFIX, tags=["V1"])
+
+
+class GreetRequest(BaseModel):
+    name: str
+
+
+class GreetResponse(BaseModel):
+    message: str
+
+
+@api_router.get("/health")
+def health_check():
+    return {"status": "ok"}
+
+
+@api_router.post("/greet", response_model=GreetResponse)
+def greet_user(payload: GreetRequest):
+    clean_name = normalize_name(payload.name)
+
+    if not clean_name:
+        raise HTTPException(status_code=400, detail="Invalid name provided")
+
+    return {"message": f"{GREETING}, {clean_name} 👋"}
+
+
+@api_router.get("/version", tags=["Version"])
+def version():
+    return {"version": api_router.version}
+
+
+@api_router.get("/index", response_class=HTMLResponse, tags=["Home"])
+async def read_root(request: Request):
+    return """
+    <html>
+        <head>
+            <title>🎉 Sample Api 🎉</title>
+            <style>
+                body {
+                    background: linear-gradient(to right, #268387, #e3898a);
+                    text-align: center;
+                    padding-top: 10%;
+                    color: #fff;
+                }
+                h1 {
+                    font-size: 3em;
+                    margin-bottom: 0.2em;
+                }
+                p {
+                    font-size: 1.2em;
+                }
+                a {
+                    color: #fff;
+                    background: #4CAF50;
+                    padding: 10px 20px;
+                    text-decoration: none;
+                    border-radius: 10px;
+                    font-weight: bold;
+                    transition: background 0.3s ease;
+                }
+                a:hover {
+                    background: #45a049;
+                }
+            </style>
+        </head>
+        <body>
+            <h1>🎈 This is sample API Tool 🎈</h1>
+            <p>Explore the <a href="/docs">API Documentation</a></p>
+        </body>
+    </html>
+    """
+
+
+@api_router.get("/help", tags=["Help"])
+def get_help():
+    return JSONResponse(
+        status_code=200,
+        content={
+            "message": "Welcome to the Sample BoilerPlate API! Visit /docs for API documentation."
+        },
+    )