agentleFS
codeApe-7codeApe-7/ai-agent-workflowGroup/skills/python/fastapi-expert/SKILL.md

fastapi-expert

Skill18 starsChanged 5 months agoMITView on GitHub

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.

  • Reads credentials

We split this skill into the rules it gives an agent

9 rules. 5 are common, 0 are distinctive, and 4 are very specific to this project.

  • 5

    Common

    Most of the 10 edited versions we read keep these.

  • 0

    Distinctive

    This author's own choices. Worth a look.

  • 4

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Common:

    Use type hints everywhere (FastAPI requires them)

    line 158
  2. Very specific:

    Use Pydantic V2 syntax (field_validator, model_validator, model_config)

    line 159
  3. Very specific:

    Use Annotated pattern for dependency injection

    line 160
  4. Common:

    Use async/await for all I/O operations

    line 161
  5. Very specific:

    Use X | None instead of Optional[X]

    line 162
  6. Common:

    Document endpoints (auto-generated OpenAPI)

    line 164
  7. Common:

    Use synchronous database operations

    line 167
  8. Very specific:

    Use Pydantic V1 syntax (@validator, class Config)

    line 171
  9. Common:

    When implementing FastAPI features, provide:

    line 177

“Common” is measured: kept by at least 6 in 10 of the 10 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

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

  1. Analyze requirements — Identify endpoints, data models, auth needs
  2. Design schemas — Create Pydantic V2 models for validation
  3. Implement — Write async endpoints with proper dependency injection
  4. Secure — Add authentication, authorization, rate limiting
  5. 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:

TopicReferenceLoad When
Pydantic V2references/pydantic-v2.mdCreating schemas, validation, model_config
SQLAlchemyreferences/async-sqlalchemy.mdAsync database, models, CRUD operations
Endpointsreferences/endpoints-routing.mdAPIRouter, dependencies, routing
Authenticationreferences/authentication.mdJWT, OAuth2, get_current_user
Testingreferences/testing-async.mdpytest-asyncio, httpx, fixtures
Django Migrationreferences/migration-from-django.mdMigrating 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:

  1. Schema file (Pydantic models)
  2. Endpoint file (router with endpoints)
  3. CRUD operations if database involved
  4. 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

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

Reviews can't be read right now.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.