FastAPI Expert
Deep expertise in async Python, Pydantic V2, and production-grade API development with FastAPI.
When to Use This Skill
- Building REST APIs with FastAPI
- Implementing Pydantic V2 validation schemas
- Setting up async database operations
- Implementing JWT authentication/authorization
- Creating WebSocket endpoints
- Optimizing API performance
Core Workflow
- Analyze requirements — Identify endpoints, data models, auth needs
- Design schemas — Create Pydantic V2 models for validation
- Implement — Write async endpoints with proper dependency injection
- Secure — Add authentication, authorization, rate limiting
- Test — Write async tests with pytest and httpx; run
pytest after each endpoint group and verify OpenAPI docs at /docs
Checkpoint after each step: confirm schemas validate correctly, endpoints return expected HTTP status codes, and /docs reflects the intended API surface before proceeding.
Minimal Complete Example
Schema + endpoint + dependency injection in one cohesive unit:
# schemas.py
from pydantic import BaseModel, EmailStr, field_validator, model_config
class UserCreate(BaseModel):
model_config = model_config(str_strip_whitespace=True)
email: EmailStr
password: str
name: str | None = None
@field_validator("password")
@classmethod
def password_strength(cls, v: str) -> str:
if len(v) < 8:
raise ValueError("Password must be at least 8 characters")
return v
class UserResponse(BaseModel):
model_config = model_config(from_attributes=True)
id: int
email: EmailStr
name: str | None = None
# routers/users.py
from fastapi import APIRouter, Depends, HTTPException, status
from sqlalchemy.ext.asyncio import AsyncSession
from typing import Annotated
from app.database import get_db
from app.schemas import UserCreate, UserResponse
from app import crud
router = APIRouter(prefix="/users", tags=["users"])
DbDep = Annotated[AsyncSession, Depends(get_db)]
@router.post("/", response_model=UserResponse, status_code=status.HTTP_201_CREATED)
async def create_user(payload: UserCreate, db: DbDep) -> UserResponse:
existing = await crud.get_user_by_email(db, payload.email)
if existing:
raise HTTPException(status_code=status.HTTP_409_CONFLICT, detail="Email already registered")
return await crud.create_user(db, payload)
# crud.py
from sqlalchemy import select
from sqlalchemy.ext.asyncio import AsyncSession
from app.models import User
from app.schemas import UserCreate
from app.security import hash_password
async def get_user_by_email(db: AsyncSession, email: str) -> User | None:
result = await db.execute(select(User).where(User.email == email))
return result.scalar_one_or_none()
async def create_user(db: AsyncSession, payload: UserCreate) -> User:
user = User(email=payload.email, hashed_password=hash_password(payload.password), name=payload.name)
db.add(user)
await db.commit()
await db.refresh(user)
return user
JWT Authentication Snippet
# security.py
from datetime import datetime, timedelta, timezone
from jose import JWTError, jwt
from fastapi import Depends, HTTPException, status
from fastapi.security import OAuth2PasswordBearer
from typing import Annotated
SECRET_KEY = "read-from-env" # use os.environ / settings
ALGORITHM = "HS256"
oauth2_scheme = OAuth2PasswordBearer(tokenUrl="/auth/token")
def create_access_token(subject: str, expires_delta: timedelta = timedelta(minutes=30)) -> str:
payload = {"sub": subject, "exp": datetime.now(timezone.utc) + expires_delta}
return jwt.encode(payload, SECRET_KEY, algorithm=ALGORITHM)
async def get_current_user(token: Annotated[str, Depends(oauth2_scheme)]) -> str:
try:
data = jwt.decode(token, SECRET_KEY, algorithms=[ALGORITHM])
subject: str | None = data.get("sub")
if subject is None:
raise ValueError
return subject
except (JWTError, ValueError):
raise HTTPException(status_code=status.HTTP_401_UNAUTHORIZED, detail="Invalid credentials")
CurrentUser = Annotated[str, Depends(get_current_user)]
Reference Guide
Load detailed guidance based on context:
| Topic |
Reference |
Load When |
| Pydantic V2 |
references/pydantic-v2.md |
Creating schemas, validation, model_config |
| SQLAlchemy |
references/async-sqlalchemy.md |
Async database, models, CRUD operations |
| Endpoints |
references/endpoints-routing.md |
APIRouter, dependencies, routing |
| Authentication |
references/authentication.md |
JWT, OAuth2, get_current_user |
| Testing |
references/testing-async.md |
pytest-asyncio, httpx, fixtures |
| Django Migration |
references/migration-from-django.md |
Migrating from Django/DRF to FastAPI |
Constraints
MUST DO
- Use type hints everywhere (FastAPI requires them)
- Use Pydantic V2 syntax (
field_validator, model_validator, model_config)
- Use
Annotated pattern for dependency injection
- Use async/await for all I/O operations
- Use
X | None instead of Optional[X]
- Return proper HTTP status codes
- Document endpoints (auto-generated OpenAPI)
MUST NOT DO
- Use synchronous database operations
- Skip Pydantic validation
- Store passwords in plain text
- Expose sensitive data in responses
- Use Pydantic V1 syntax (
@validator, class Config)
- Mix sync and async code improperly
- Hardcode configuration values
Output Templates
When implementing FastAPI features, provide:
- Schema file (Pydantic models)
- Endpoint file (router with endpoints)
- CRUD operations if database involved
- Brief explanation of key decisions
Knowledge Reference
FastAPI, Pydantic V2, async SQLAlchemy, Alembic migrations, JWT/OAuth2, pytest-asyncio, httpx, BackgroundTasks, WebSockets, dependency injection, OpenAPI/Swagger
Documentation
1---2name: fastapi-expert3description: Use when building high-performance async Python APIs with FastAPI and Pydantic V2. Invoke to create REST endpoints, define Pydantic models, implement authentication flows, set up async SQLAlchemy database operations, add JWT authentication, build WebSocket endpoints, or generate OpenAPI documentation. Trigger terms: FastAPI, Pydantic, async Python, Python API, REST API Python, SQLAlchemy async, JWT authentication, OpenAPI, Swagger Python.4license: MIT5---67# FastAPI Expert89Deep expertise in async Python, Pydantic V2, and production-grade API development with FastAPI.1011## When to Use This Skill1213- Building REST APIs with FastAPI14- Implementing Pydantic V2 validation schemas15- Setting up async database operations16- Implementing JWT authentication/authorization17- Creating WebSocket endpoints18- Optimizing API performance1920## Core Workflow21221. **Analyze requirements** — Identify endpoints, data models, auth needs232. **Design schemas** — Create Pydantic V2 models for validation243. **Implement** — Write async endpoints with proper dependency injection254. **Secure** — Add authentication, authorization, rate limiting265. **Test** — Write async tests with pytest and httpx; run `pytest` after each endpoint group and verify OpenAPI docs at `/docs`2728> **Checkpoint after each step:** confirm schemas validate correctly, endpoints return expected HTTP status codes, and `/docs` reflects the intended API surface before proceeding.2930## Minimal Complete Example3132Schema + endpoint + dependency injection in one cohesive unit:3334```python35# schemas.py36from pydantic import BaseModel, EmailStr, field_validator, model_config3738class UserCreate(BaseModel):39 model_config = model_config(str_strip_whitespace=True)4041 email: EmailStr42 password: str43 name: str | None = None4445 @field_validator("password")46 @classmethod47 def password_strength(cls, v: str) -> str:48 if len(v) < 8:49 raise ValueError("Password must be at least 8 characters")50 return v5152class UserResponse(BaseModel):53 model_config = model_config(from_attributes=True)5455 id: int56 email: EmailStr57 name: str | None = None58```5960```python61# routers/users.py62from fastapi import APIRouter, Depends, HTTPException, status63from sqlalchemy.ext.asyncio import AsyncSession64from typing import Annotated6566from app.database import get_db67from app.schemas import UserCreate, UserResponse68from app import crud6970router = APIRouter(prefix="/users", tags=["users"])7172DbDep = Annotated[AsyncSession, Depends(get_db)]7374@router.post("/", response_model=UserResponse, status_code=status.HTTP_201_CREATED)75async def create_user(payload: UserCreate, db: DbDep) -> UserResponse:76 existing = await crud.get_user_by_email(db, payload.email)77 if existing:78 raise HTTPException(status_code=status.HTTP_409_CONFLICT, detail="Email already registered")79 return await crud.create_user(db, payload)80```8182```python83# crud.py84from sqlalchemy import select85from sqlalchemy.ext.asyncio import AsyncSession86from app.models import User87from app.schemas import UserCreate88from app.security import hash_password8990async def get_user_by_email(db: AsyncSession, email: str) -> User | None:91 result = await db.execute(select(User).where(User.email == email))92 return result.scalar_one_or_none()9394async def create_user(db: AsyncSession, payload: UserCreate) -> User:95 user = User(email=payload.email, hashed_password=hash_password(payload.password), name=payload.name)96 db.add(user)97 await db.commit()98 await db.refresh(user)99 return user100```101102## JWT Authentication Snippet103104```python105# security.py106from datetime import datetime, timedelta, timezone107from jose import JWTError, jwt108from fastapi import Depends, HTTPException, status109from fastapi.security import OAuth2PasswordBearer110from typing import Annotated111112SECRET_KEY = "read-from-env" # use os.environ / settings113ALGORITHM = "HS256"114oauth2_scheme = OAuth2PasswordBearer(tokenUrl="/auth/token")115116def create_access_token(subject: str, expires_delta: timedelta = timedelta(minutes=30)) -> str:117 payload = {"sub": subject, "exp": datetime.now(timezone.utc) + expires_delta}118 return jwt.encode(payload, SECRET_KEY, algorithm=ALGORITHM)119120async def get_current_user(token: Annotated[str, Depends(oauth2_scheme)]) -> str:121 try:122 data = jwt.decode(token, SECRET_KEY, algorithms=[ALGORITHM])123 subject: str | None = data.get("sub")124 if subject is None:125 raise ValueError126 return subject127 except (JWTError, ValueError):128 raise HTTPException(status_code=status.HTTP_401_UNAUTHORIZED, detail="Invalid credentials")129130CurrentUser = Annotated[str, Depends(get_current_user)]131```132133## Reference Guide134135Load detailed guidance based on context:136137| Topic | Reference | Load When |138|-------|-----------|-----------|139| Pydantic V2 | `references/pydantic-v2.md` | Creating schemas, validation, model_config |140| SQLAlchemy | `references/async-sqlalchemy.md` | Async database, models, CRUD operations |141| Endpoints | `references/endpoints-routing.md` | APIRouter, dependencies, routing |142| Authentication | `references/authentication.md` | JWT, OAuth2, get_current_user |143| Testing | `references/testing-async.md` | pytest-asyncio, httpx, fixtures |144| Django Migration | `references/migration-from-django.md` | Migrating from Django/DRF to FastAPI |145146## Constraints147148### MUST DO149- Use type hints everywhere (FastAPI requires them)150- Use Pydantic V2 syntax (`field_validator`, `model_validator`, `model_config`)151- Use `Annotated` pattern for dependency injection152- Use async/await for all I/O operations153- Use `X | None` instead of `Optional[X]`154- Return proper HTTP status codes155- Document endpoints (auto-generated OpenAPI)156157### MUST NOT DO158- Use synchronous database operations159- Skip Pydantic validation160- Store passwords in plain text161- Expose sensitive data in responses162- Use Pydantic V1 syntax (`@validator`, `class Config`)163- Mix sync and async code improperly164- Hardcode configuration values165166## Output Templates167168When implementing FastAPI features, provide:1691. Schema file (Pydantic models)1702. Endpoint file (router with endpoints)1713. CRUD operations if database involved1724. Brief explanation of key decisions173174## Knowledge Reference175176FastAPI, Pydantic V2, async SQLAlchemy, Alembic migrations, JWT/OAuth2, pytest-asyncio, httpx, BackgroundTasks, WebSockets, dependency injection, OpenAPI/Swagger177178[Documentation](https://jeffallan.github.io/claude-skills/skills/backend/fastapi-expert/)