Nested Models for Complex Data Structures

Welcome to another lesson. This time we will explore how to handle intricate data relationships using nested Pydantic models within FastAPI. You will learn how to define nested data structures, create corresponding Pydantic models, and use these models in your FastAPI endpoints for validation and data manipulation.

Nested models are crucial for representing complex data structures in a manner similar to how relational databases handle related tables. In a real database, you would have tables with foreign keys to represent relationships.

Similarly, in FastAPI, nested models let us encapsulate these relationships within a single model, streamlining data validation and manipulation. This way, our application can handle complex data interactions just as efficiently as a well-structured database.

To work effectively with nested data structures, we'll represent the complexity using Pydantic models in our FastAPI application. Let's start by creating a FastAPI app with a mock dataset that includes nested relationships.

Here's an example of a mock database of crew members, each with nested equipment data:

from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()

# Mock database of crew members with nested equipment data
crew = [
    {
        "id": 1,
        "name": "Cosmo", "role": "Captain", "experience": 10,
        "equipment": [
            {"name": "Helmet", "status": "Good"},
            {"name": "Suit", "status": "Needs Repair"}
        ]
    },
    {
        "id": 2,
        "name": "Alice", "role": "Engineer", "experience": 8,
        "equipment": [
            {"name": "Toolkit", "status": "Good"}
        ]
    },
]

In this structure, each crew member has a list of equipment objects associated with them. Now, let's define Pydantic models to represent these nested data structures.

First, let's define the Equipment model. This model will represent the equipment associated with each crew member. Here's the code:

class Equipment(BaseModel):
    name: str
    status: str

The Equipment model has two fields: name for the equipment's name and status for its current status.