Main Site โ†—

fastapi

by jezweb67523GitHub

Build Python APIs with FastAPI, Pydantic v2, and SQLAlchemy 2.0 async. Covers project structure, JWT auth, validation, and database integration with uv package manager. Prevents 7 documented errors. Use when: creating Python APIs, implementing JWT auth, or troubleshooting 422 validation, CORS, async blocking, form data, background tasks, or OpenAPI schema errors.

Unlock Deep Analysis

Use AI to visualize the workflow and generate a realistic output preview for this skill.

Powered by Fastest LLM

Target Audience

Python developers building REST APIs with FastAPI who need practical implementation patterns, especially those new to async SQLAlchemy or JWT authentication

10/10Security

Low security risk, safe to use

9
Clarity
9
Practicality
8
Quality
9
Maintainability
7
Innovation
Development
Compatible Agents
Claude Code
Claude Code
~/.claude/skills/
Codex CLI
Codex CLI
~/.codex/skills/
Gemini CLI
Gemini CLI
~/.gemini/skills/
O
OpenCode
~/.opencode/skills/
O
OpenClaw
~/.openclaw/skills/
GitHub Copilot
GitHub Copilot
~/.copilot/skills/
Cursor
Cursor
~/.cursor/skills/
W
Windsurf
~/.codeium/windsurf/skills/
C
Cline
~/.cline/skills/
R
Roo Code
~/.roo/skills/
K
Kiro
~/.kiro/skills/
J
Junie
~/.junie/skills/
A
Augment Code
~/.augment/skills/
W
Warp
~/.warp/skills/
G
Goose
~/.config/goose/skills/
SKILL.md

FastAPI Patterns

Async Traps

  • Mixing sync database drivers (psycopg2, PyMySQL) in async endpoints blocks the event loop โ€” use async drivers (asyncpg, aiomysql) or run sync code in run_in_executor
  • time.sleep() in async endpoints blocks everything โ€” use await asyncio.sleep() instead
  • CPU-bound work in async endpoints starves other requests โ€” offload to ProcessPoolExecutor or background workers
  • Async endpoints calling sync functions that do I/O still block โ€” the entire call chain must be async

Pydantic Validation

  • Default values in models become shared mutable state: items: list = [] shares the same list across requests โ€” use Field(default_factory=list)
  • Optional[str] doesn't make a field optional in the request โ€” add = None or use Field(default=None)
  • Pydantic v2 uses model_validate() not parse_obj(), and model_dump() not .dict() โ€” v1 methods are deprecated
  • Use Annotated[str, Field(min_length=1)] for reusable validated types instead of repeating constraints

Dependency Injection

  • Dependencies run on every request by default โ€” use lru_cache on expensive dependencies or cache in app.state for singletons
  • Depends() without an argument reuses the type hint as the dependency โ€” clean but can confuse readers
  • Nested dependencies form a DAG โ€” if A depends on B and C, and both B and C depend on D, D runs once (cached per-request)
  • yield dependencies for cleanup (DB sessions, file handles) โ€” code after yield runs even if the endpoint raises

Lifespan and Startup

  • @app.on_event("startup") is deprecated โ€” use lifespan async context manager
  • Store shared resources (DB pool, HTTP client) in app.state during lifespan, not as global variables
  • Lifespan runs once per worker process โ€” with 4 Uvicorn workers you get 4 DB pools
from contextlib import asynccontextmanager
@asynccontextmanager
async def lifespan(app):
    app.state.db = await create_pool()
    yield
    await app.state.db.close()
app = FastAPI(lifespan=lifespan)

Request/Response

  • Return dict from endpoints, not Pydantic models directly โ€” FastAPI handles serialization and it's faster
  • Use status_code=201 on POST endpoints returning created resources โ€” 200 is the default but semantically wrong
  • Response with media_type="text/plain" for non-JSON responses โ€” returning a string still gets JSON-encoded otherwise
  • Set response_model_exclude_unset=True to omit None fields from response โ€” cleaner API output

Error Handling

  • raise HTTPException(status_code=404) โ€” don't return Response objects for errors, it bypasses middleware
  • Custom exception handlers with @app.exception_handler(CustomError) โ€” but remember they don't catch HTTPException
  • Use detail= for user-facing messages, log the actual error separately โ€” don't leak stack traces

Background Tasks

  • BackgroundTasks runs after the response is sent but still in the same process โ€” not suitable for long-running jobs
  • Tasks execute sequentially in order added โ€” don't assume parallelism
  • If a background task fails, the client never knows โ€” add your own error handling and alerting

Security

  • OAuth2PasswordBearer is for documentation only โ€” it doesn't validate tokens, you must implement that in the dependency
  • CORS middleware must come after exception handlers in middleware order โ€” or errors won't have CORS headers
  • Depends(get_current_user) in path operation, not in router โ€” dependencies on routers affect all routes including health checks

Testing

  • TestClient runs sync even for async endpoints โ€” use httpx.AsyncClient with ASGITransport for true async testing
  • Override dependencies with app.dependency_overrides[get_db] = mock_db โ€” cleaner than monkeypatching
  • TestClient context manager ensures lifespan runs โ€” without with TestClient(app) as client: startup/shutdown hooks don't fire

Source: https://github.com/jezweb/claude-skills#skills-fastapi

Content curated from original sources, copyright belongs to authors

Grade A
8.4AI Score
Best Practices
Checking...
Try this Skill

User Rating

USER RATING

0UP
0DOWN
Loading files...

WORKS WITH

Claude Code
Claude
Codex CLI
Codex
Gemini CLI
Gemini
O
OpenCode
O
OpenClaw
GitHub Copilot
Copilot
Cursor
Cursor
W
Windsurf
C
Cline
R
Roo
K
Kiro
J
Junie
A
Augment
W
Warp
G
Goose