Data Modeling with Pydantic and FastAPI

Welcome to another step in our journey with FastAPI! After getting your hands dirty with the basics of FastAPI and creating advanced endpoints, we're now ready to dive into data models. These concepts form the backbone of structured data handling within FastAPI applications, and this will be our focus in this lesson. FastAPI leverages the power of Python's dataclasses for data validation, serialization, and documentation synchronization through a powerful library — Pydantic . Our goal for today's lesson is to get comfortable with defining Pydantic models and using them in our FastAPI application responses. Resources are already in place to help you practice and understand these concepts more concretely. So, let's dive straight in!

What is Pydantic?

Pydantic is a data validation library that provides a way for us to create and handle complex data structures with built-in validation. But how does Pydantic fit into FastAPI? In FastAPI, we use Pydantic models to build easy-to-understand, predictable data structures, with incorporated type-checking and validation. When we design powerful APIs, structuring, validating, serializing, and documenting our data is crucial, and Pydantic models are the perfect tool to help us accomplish this.

The Role of Pydantic Models in FastAPI

Pydantic models allow us to create and validate complex data structures and forms, ensuring data integrity throughout our application. These models establish a clear contract of what kind of data is expected in our endpoints' requests and responses. In addition to this, FastAPI leverages Pydantic's models for automatic documentation. So, it's not only about defining our application's data. It's also about developing clean, self-documented APIs without extra effort.

Recap of Our Setup

Before diving deeper, let's recap our application setup. We have a FastAPI application with a mock database of crew members. Each crew member has an id, name, and role. Now, we are introducing a new field, experience, to our mock database. Here is the updated mock database setup: Python from fastapi import FastAPI # Initialize FastAPI app app = FastAPI() # Mock database of crew members crew = [{"id": 1, "name": "Cosmo", "role": "Captain", "experience": 10}, {"id": 2, "name": "Alice", "role": "Engineer", "experience": 8}, {"id": 3, "name": "Bob", "role": "Scientist", "experience": 5}] from fastapi import FastAPI # Initialize FastAPI app app = FastAPI() # Mock database of crew members crew = [{"id": 1, "name": "Cosmo", "role": "Captain", "experience": 10}, {"id": 2, "name": "Alice", "role": "Engineer", "experience": 8}, {"id": 3, "name": "Bob", "role": "Scientist", "experience": 5}]

Join the 1M+ learners on CodeSignal

Be a part of our community of 1M+ users who develop and demonstrate their skills on CodeSignal

Python

from fastapi import FastAPI

# Initialize FastAPI app
app = FastAPI()

# Mock database of crew members
crew = [
    {"id": 1, "name": "Cosmo", "role": "Captain", "experience": 10},
    {"id": 2, "name": "Alice", "role": "Engineer", "experience": 8},
    {"id": 3, "name": "Bob", "role": "Scientist", "experience": 5}
]

Python

from pydantic import BaseModel

class CrewMember(BaseModel):
    name: str
    role: str
    experience: int

from pydantic import BaseModel

class CrewMember(BaseModel):
    name: str
    role: str
    experience: int

Python

@app.get("/crew/{crew_id}", response_model=CrewMember)
async def read_crew_member(crew_id: int):
    # ... remaining code ...

@app.get("/crew/{crew_id}", response_model=CrewMember)
async def read_crew_member(crew_id: int):
    # ... remaining code ...

Python

from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()

# Mock database of crew members
crew = [
    {"id": 1, "name": "Cosmo", "role": "Captain", "experience": 10},
    {"id": 2, "name": "Alice", "role": "Engineer", "experience": 8},
    {"id": 3, "name": "Bob", "role": "Scientist", "experience": 5}
]

# Defining a Pydantic model for the crew member
class CrewMember(BaseModel):
    name: str
    role: str
    experience: int

# GET endpoint to read a crew member details using response model
@app.get("/crew/{crew_id}", response_model=CrewMember)
async def read_crew_member(crew_id: int):
    # Finding member in crew
    for member in crew:
        if member["id"] == crew_id:
            return member

from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()

# Mock database of crew members
crew = [
    {"id": 1, "name": "Cosmo", "role": "Captain", "experience": 10},
    {"id": 2, "name": "Alice", "role": "Engineer", "experience": 8},
    {"id": 3, "name": "Bob", "role": "Scientist", "experience": 5}
]

# Defining a Pydantic model for the crew member
class CrewMember(BaseModel):
    name: str
    role: str
    experience: int

# GET endpoint to read a crew member details using response model
@app.get("/crew/{crew_id}", response_model=CrewMember)
async def read_crew_member(crew_id: int):
    # Finding member in crew
    for member in crew:
        if member["id"] == crew_id:
            return member

text

{
    "name": "Cosmo",
    "role": "Captain",
    "experience": 10
}

{
    "name": "Cosmo",
    "role": "Captain",
    "experience": 10
}

text

1 validation errors:
{'type': 'model_attributes_type', 'loc': ('response',), 'msg': 'Input should be a valid dictionary or object to extract fields from', 'input': None}

1 validation errors:
{'type': 'model_attributes_type', 'loc': ('response',), 'msg': 'Input should be a valid dictionary or object to extract fields from', 'input': None}

Python

from pydantic import BaseModel

class CrewMember(BaseModel):
    name: str
    role: str
    experience: int

Python

@app.get("/crew/{crew_id}", response_model=CrewMember)
async def read_crew_member(crew_id: int):
    # ... remaining code ...

Python

from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()

# Mock database of crew members
crew = [
    {"id": 1, "name": "Cosmo", "role": "Captain", "experience": 10},
    {"id": 2, "name": "Alice", "role": "Engineer", "experience": 8},
    {"id": 3, "name": "Bob", "role": "Scientist", "experience": 5}
]

# Defining a Pydantic model for the crew member
class CrewMember(BaseModel):
    name: str
    role: str
    experience: int

# GET endpoint to read a crew member details using response model
@app.get("/crew/{crew_id}", response_model=CrewMember)
async def read_crew_member(crew_id: int):
    # Finding member in crew
    for member in crew:
        if member["id"] == crew_id:
            return member

text

{
    "name": "Cosmo",
    "role": "Captain",
    "experience": 10
}

text

1 validation errors:
{'type': 'model_attributes_type', 'loc': ('response',), 'msg': 'Input should be a valid dictionary or object to extract fields from', 'input': None}

Data Modeling with Pydantic and FastAPI

What is Pydantic?

The Role of Pydantic Models in FastAPI

Recap of Our Setup

Join the 1M+ learners on CodeSignal

Constructing a Pydantic Model

Incorporating Pydantic Model in Response

Understanding Response Model and Pydantic

Example of Implementation

Possible Responses

Review and Preparing for the Practice