Nested models in FastAPI - Step-by-Step Execution

Concept Flow - Nested models

Define Base Model

↓

Define Nested Model

↓

Use Nested Model as Field in Parent Model

↓

Create Instance of Parent Model

↓

Validate Nested Data Automatically

↓

Access Nested Data via Parent Instance

Shows how a model contains another model as a field, enabling structured nested data validation.

Execution Sample

FastAPI

from pydantic import BaseModel

class Address(BaseModel):
    city: str
    country: str

class User(BaseModel):
    name: str
    address: Address

Defines a User model with a nested Address model to validate structured user data.

Execution Table

Step	Action	Input Data	Validation Result	Output Instance
1	Define Address model	N/A	Model created	Address class ready
2	Define User model with Address field	N/A	Model created	User class ready
3	Create User instance with nested dict	{'name': 'Alice', 'address': {'city': 'Paris', 'country': 'France'}}	Valid data	User(name='Alice', address=Address(city='Paris', country='France'))
4	Access nested field	user.address.city	Returns 'Paris'	'Paris'
5	Create User instance with invalid nested data	{'name': 'Bob', 'address': {'city': 123, 'country': 'USA'}}	Validation error: city must be str	Error raised

💡 Execution stops after validation error on nested model field type mismatch.

Variable Tracker

Variable	Start	After Step 3	After Step 4	After Step 5
user	undefined	User(name='Alice', address=Address(city='Paris', country='France'))	User(name='Alice', address=Address(city='Paris', country='France')) (accessed nested city)	Error raised, no valid user instance

Key Moments - 2 Insights

Why does the nested 'address' field accept a dictionary when creating a User?

Because Pydantic automatically converts nested dictionaries into the nested model instances, as shown in execution_table step 3.

What happens if the nested data type is wrong, like city being a number?

Validation fails and raises an error, stopping instance creation, as shown in execution_table step 5.

Visual Quiz - 3 Questions

Look at the execution table, what is the value of user.address.city after step 4?

A 'Paris'

B 'France'

C 123

D Error

💡 Hint

Check the Output Instance column at step 4 where nested field is accessed.

At which step does validation fail due to wrong nested data type?

A Step 3

B Step 5

C Step 4

D No failure

💡 Hint

Look for 'Validation error' in the Validation Result column.

If the Address model had an extra field 'zipcode', what would happen when creating User without it?

A zipcode defaults to None automatically

B User instance created ignoring zipcode

C Validation error for missing zipcode

D No effect, zipcode is optional by default

💡 Hint

Pydantic requires all fields unless given defaults; see validation behavior in steps 3 and 5.

Concept Snapshot

Nested models in FastAPI use Pydantic models inside other models.
Define a model (e.g., Address), then use it as a field in another model (e.g., User).
When creating the parent model, nested dicts convert automatically to nested model instances.
Validation applies recursively, so nested data must match expected types.
Access nested data via dot notation (user.address.city).
Validation errors stop instance creation if nested data is invalid.

Full Transcript

This visual execution trace shows how nested models work in FastAPI using Pydantic. First, we define a simple Address model with city and country fields. Then, we define a User model that includes an Address as a nested field. When creating a User instance, we can pass a dictionary for the address, and Pydantic automatically converts it into an Address instance. Accessing nested fields like user.address.city returns the expected values. If nested data types are wrong, such as city being a number instead of a string, validation fails and raises an error, preventing instance creation. This ensures data is structured and validated deeply, making nested models powerful for complex data shapes.

Practice

1. What is the main purpose of using nested models in FastAPI?

easy

A. To represent complex data structures by embedding one model inside another

B. To speed up the API response time

C. To automatically generate HTML pages

D. To replace database models with simpler ones

Solution

1. Step 1: Understand nested models concept

   Nested models allow you to include one Pydantic model inside another to represent complex or hierarchical data.

2. Step 2: Identify the main purpose in FastAPI

   FastAPI uses nested models to validate and structure complex JSON data clearly and maintainably.

3. Final Answer:

   To represent complex data structures by embedding one model inside another -> Option A

4. Quick Check:

   Nested models = complex data representation [OK]

Hint: Nested models = models inside models for complex data [OK]

Common Mistakes:

• Thinking nested models improve speed
• Confusing nested models with HTML generation
• Assuming nested models replace databases

2. Which of the following is the correct way to define a nested model in FastAPI using Pydantic?

easy

A. class User(BaseModel): name: str; address: str

B. class Address(BaseModel): street: str; class User(BaseModel): name: str; address: Address

C. class User(BaseModel): name: str; address = Address()

D. class Address: street: str; class User: name: str; address: Address

Solution

1. Step 1: Check Pydantic model syntax

   Models must inherit from BaseModel and use type annotations for fields.

2. Step 2: Verify nested model usage

   Nested models are declared by using the nested model class as a type annotation for a field.

3. Final Answer:

   class Address(BaseModel): street: str; class User(BaseModel): name: str; address: Address -> Option B

4. Quick Check:

   Nested model as type annotation = correct syntax [OK]

Hint: Use nested model class as field type with BaseModel inheritance [OK]

Common Mistakes:

• Not inheriting from BaseModel
• Assigning nested model instance instead of type
• Using plain classes without BaseModel

3. Given the following FastAPI models:

class Item(BaseModel): name: str; price: float
class Order(BaseModel): id: int; item: Item

What will be the output of Order(id=1, item={'name': 'Book', 'price': 12.5}).item.price?

medium

A. None

B. '12.5'

C. Error: item must be an Item instance

D. 12.5

Solution

1. Step 1: Understand nested model instantiation

   FastAPI/Pydantic automatically converts nested dicts to model instances when creating the parent model.

2. Step 2: Access nested attribute

   Accessing item.price returns the float value 12.5 from the nested Item model.

3. Final Answer:

   12.5 -> Option D

4. Quick Check:

   Nested dict converts to model, attribute accessed = 12.5 [OK]

Hint: Nested dicts auto-convert to models, access attributes normally [OK]

Common Mistakes:

• Expecting string instead of float
• Thinking nested dicts cause errors
• Assuming nested model must be instance, not dict

4. Identify the error in this FastAPI nested model code:

class Profile(BaseModel): age: int
class User(BaseModel): username: str; profile = {"age": 30}

medium

A. Missing type annotation for profile field

B. Profile class must inherit from BaseSettings, not BaseModel

C. Default value for nested model must be a Profile instance, not a dict

D. username field should be Optional[str]

Solution

1. Step 1: Check field type annotations

   All Pydantic model fields require type annotations (: Type) for proper validation, especially for nested models.

2. Step 2: Identify the missing annotation

   The profile field lacks type annotation: it should be profile: Profile = {"age": 30} or profile: Profile = Profile(age=30) to enable nested model validation.

3. Final Answer:

   Missing type annotation for profile field -> Option A

4. Quick Check:

   Type annotation required for nested model fields [OK]

Hint: All model fields must have type annotations: field: Type [OK]

Common Mistakes:

• Using dict instead of model instance as default
• Ignoring type annotations
• Confusing BaseModel with BaseSettings

5. You want to create a FastAPI model for a blog post with nested author info. The author has name and email. The post has title, content, and author. Which code correctly defines these nested models and validates that the author's email is a valid email address?

hard

A. class Author(BaseModel): name: str; email: str
class Post(BaseModel): title: str; content: str; author: Author

@validator('email')
def check_email(cls, v): return v

B. class Author(BaseModel): name: str; email: str
class Post(BaseModel): title: str; content: str; author: dict

C. class Author(BaseModel): name: str; email: EmailStr
class Post(BaseModel): title: str; content: str; author: Author

D. class Author(BaseModel): name: str; email: EmailStr
class Post(BaseModel): title: str; content: str; author: dict

Solution

1. Step 1: Use EmailStr for email validation

   Pydantic provides EmailStr type to validate email addresses automatically.

2. Step 2: Define nested models correctly

   Author model uses EmailStr, Post model nests Author as a field with correct type annotation.

3. Final Answer:

   class Author(BaseModel): name: str; email: EmailStr class Post(BaseModel): title: str; content: str; author: Author -> Option C

4. Quick Check:

   EmailStr + nested Author model = correct validation [OK]

Hint: Use EmailStr type and nested model as field type [OK]

Common Mistakes:

• Using plain str for email without validation
• Setting author field as dict instead of Author model
• Trying to validate email with incorrect validator placement