Response Pydantic

Learn the fundamentals of response pydantic in FastAPI.

🎯 Core Concept

Pydantic models in FastAPI serve dual purposes: validating input data AND ensuring response quality. Using Pydantic for responses provides automatic validation, documentation, and type safety throughout your API.

📖 What You'll Learn

In this section, you'll understand:

• Using Pydantic BaseModel for responses

• Benefits of response model validation

• Type hints in response models

• Default values and optional fields

• Response model constraints

💡 Basic Response Model

from fastapi import FastAPI
from pydantic import BaseModel
from typing import Optional

app = FastAPI()

class Item(BaseModel):
    id: int
    name: str
    price: float
    description: Optional[str] = None
    in_stock: bool = True

@app.get("/items/{item_id}", response_model=Item)
async def get_item(item_id: int):
    return {
        "id": item_id,
        "name": "Widget",
        "price": 9.99,
        "in_stock": True
    }

Response Model with Validation

from pydantic import BaseModel, Field

class Product(BaseModel):
    id: int
    name: str = Field(..., min_length=1, max_length=100)
    price: float = Field(..., gt=0, le=999999)
    quantity: int = Field(default=0, ge=0)

@app.post("/products", response_model=Product)
async def create_product(product: Product):
    # Pydantic validates response matches model
    return product.dict()

Database Model to Response

from sqlalchemy import Column, Integer, String
from sqlalchemy.ext.declarative import declarative_base

Base = declarative_base()

class UserDB(Base):
    __tablename__ = "users"
    id = Column(Integer, primary_key=True)
    name = Column(String)
    email = Column(String)

class UserResponse(BaseModel):
    id: int
    name: str
    email: str

@app.get("/users/{user_id}", response_model=UserResponse)
async def get_user(user_id: int, db: Session = Depends(get_db)):
    user = db.query(UserDB).filter(UserDB.id == user_id).first()
    return user  # Pydantic converts DB model to response

Real-World Usage

Response models are critical for:

• **Validation**: Ensure response data matches expected schema

• **Documentation**: Auto-generate Swagger UI documentation

• **Type Safety**: IDE autocomplete and static type checking

• **Filtering**: Exclude sensitive fields automatically

• **Consistency**: All responses follow defined structure

🔑 Key Takeaways

• ✅ Understand the purpose of response pydantic

• ✅ Know when to apply this pattern

• ✅ Recognize its benefits in real-world scenarios

• ✅ Be prepared to use it in your projects

Ready to explore more? Check out the advanced section for production patterns and edge cases.