caddis-plugin: Instructions file for GitHub Copilot

FastAPI Development Guidelines

Standards for building FastAPI backends with proper structure, validation, and security.

Project Structure

backend/
├── app/
│   ├── __init__.py
│   ├── main.py              # FastAPI application entry
│   ├── config.py            # Settings and configuration
│   ├── dependencies.py      # Shared dependencies
│   ├── routers/
│   │   ├── __init__.py
│   │   ├── complaints.py
│   │   └── analytics.py
│   ├── models/
│   │   ├── __init__.py
│   │   ├── complaint.py     # Pydantic models
│   │   └── user.py
│   ├── services/
│   │   ├── __init__.py
│   │   └── complaint_service.py
│   └── repositories/
│       ├── __init__.py
│       └── complaint_repo.py
├── tests/
├── .env
└── requirements.txt

Application Setup

Main Application

# app/main.py
from fastapi import FastAPI
from fastapi.middleware.cors import CORSMiddleware
from contextlib import asynccontextmanager
from loguru import logger

from app.config import settings
from app.routers import complaints, analytics

@asynccontextmanager
async def lifespan(app: FastAPI):
    """Manage application lifecycle."""
    logger.info("Starting API...")
    # Startup: Initialize connections, load models
    yield
    # Shutdown: Clean up resources
    logger.info("Shutting down API...")

app = FastAPI(
    title="<APP_TITLE> API",       # from project-config.md
    description="<APP_DESCRIPTION>",  # from project-config.md
    version="1.0.0",
    lifespan=lifespan
)

# CORS configuration
app.add_middleware(
    CORSMiddleware,
    allow_origins=settings.allowed_origins,
    allow_credentials=True,
    allow_methods=["*"],
    allow_headers=["*"],
)

# Include routers
app.include_router(complaints.router, prefix="/api/v1/complaints", tags=["complaints"])
app.include_router(analytics.router, prefix="/api/v1/analytics", tags=["analytics"])

@app.get("/health")
async def health_check():
    """Health check endpoint for monitoring."""
    return {"status": "healthy", "version": "1.0.0"}