Backend · Any coding agent
Python FastAPI & Pydantic v2 ARCHITECTURE.md
An ARCHITECTURE.md for Python FastAPI & Pydantic v2: module responsibilities, data flow and the boundaries code changes must keep.
- Path
- ARCHITECTURE.md
- Loads
- Read when referenced
- Format
- Markdown (.md)
- Used by
- Any coding agent
What this file tells the agent
ARCHITECTURE.md describes module responsibilities, state boundaries and data flow, so a coding agent knows where code belongs before it changes anything. Point to it from CLAUDE.md or AGENTS.md so agents read it.
- Use strict Pydantic v2 BaseModels with Field validation for all input and output schemas.
- Use asynchronous route handlers (`async def`) for database operations and external API requests.
- Inject dependencies using FastAPI `Depends` pattern; avoid global state.
- Type annotate 100% of function signatures with Python 3.12+ type hints.
Code to avoid, and what to write instead
The rule steers the agent away from the left and toward the right.
@app.post("/users")
def make_user(data: dict):
# Missing types, sync blocking query
return db.query(data["email"])from fastapi import APIRouter, Depends, HTTPException
from pydantic import BaseModel, Field
router = APIRouter()
class UserPayload(BaseModel):
email: str = Field(..., min_length=5)
@router.post("/users")
async def create_user(payload: UserPayload, db = Depends(get_db)):
return await db.users.create(payload.model_dump())Install it in one command
- 01
Go to your project root
The file goes at ARCHITECTURE.md, relative to the root.
- 02
Download the file
Run the command on the right. It downloads this preset and writes the file.
- 03
Make sure it gets used
Agents read it when your CLAUDE.md or AGENTS.md points to it. Add a line such as "Read ARCHITECTURE.md before structural changes".
$ curl -fsSL "https://www.devscratchpad.tech/api/raw/architecture-md/fastapi" -o "ARCHITECTURE.md"
writes ARCHITECTURE.md
ARCHITECTURE.md
To write the file from your own code instead, use Read your code or Convert Legacy Rules in the editor above.
More for Python FastAPI & Pydantic v2
Other ARCHITECTURE.md presets
Questions
- What belongs in ARCHITECTURE.md?
- How the main modules relate, how state and data flow, and the boundaries every change must keep.
- How does ARCHITECTURE.md help AI agents?
- It tells them where code belongs and which boundaries to keep, so they are less likely to add circular dependencies or skip layers. Point to it from CLAUDE.md or AGENTS.md so they read it.