Pydantic model definition in FastAPI - Mini Project: Build & Apply

Pydantic Model Definition in FastAPI

📖 Scenario: You are building a simple FastAPI app to manage a list of books. Each book has a title, author, and number of pages.

🎯 Goal: Create a Pydantic model to define the structure of a book. This model will help FastAPI validate incoming data and generate API docs.

📋 What You'll Learn

Create a Pydantic model named Book

Include fields title (string), author (string), and pages (integer)

Set up a FastAPI app instance named app

Create a POST endpoint /books/ that accepts a Book model

💡 Why This Matters

🌍 Real World

APIs often need to validate incoming data to avoid errors and security issues. Pydantic models help define clear data rules.

💼 Career

FastAPI and Pydantic are popular tools for backend development. Knowing how to define models and endpoints is essential for building reliable web services.

1

Create the Pydantic model

Write a Pydantic model named Book with these fields: title as str, author as str, and pages as int. Import BaseModel from pydantic.

FastAPI

from pydantic import BaseModel

# Define the Book model here
# Your code here

Hint

Remember to import BaseModel from pydantic and create a class that inherits from it.

2

Set up FastAPI app instance

Import FastAPI from fastapi and create an app instance named app.

FastAPI

from fastapi import FastAPI

# Create FastAPI app instance
# Your code here

Hint

Use app = FastAPI() to create the app instance.

3

Create POST endpoint to receive Book data

Define a POST endpoint /books/ using @app.post("/books/"). Create a function create_book that takes a parameter book of type Book.

FastAPI

# Define POST endpoint to create a book
# Your code here

Hint

Use @app.post("/books/") decorator and define an async function with a book parameter typed as Book.

4

Complete the FastAPI app

Ensure the full code includes the Book model, the app instance, and the POST endpoint /books/ that returns the received book data.

FastAPI

# Finalize the FastAPI app
# Your code here

Hint

Check that all parts are included and correctly indented.

Practice

1. What is the main purpose of defining a Pydantic model in FastAPI?

easy

A. To specify the expected data structure and validate incoming data automatically

B. To create database tables automatically

C. To style the API responses with CSS

D. To handle user authentication

Solution

1. Step 1: Understand Pydantic model role

   Pydantic models define the shape and types of data expected in requests or responses.

2. Step 2: Identify validation feature

   They automatically check if incoming data matches the defined types and structure.

3. Final Answer:

   To specify the expected data structure and validate incoming data automatically -> Option A

4. Quick Check:

   Data validation = C [OK]

Hint: Pydantic models shape and check data automatically [OK]

Common Mistakes:

• Confusing Pydantic models with database models
• Thinking Pydantic handles styling or authentication
• Assuming Pydantic models run code logic

2. Which of the following is the correct way to define a Pydantic model with a required string field name and an optional integer field age?

easy

A. class User(BaseModel): name: str; age: int = None

B. class User(BaseModel): name: str; age: Optional[int] = None

C. class User(BaseModel): name = str; age = int = None

D. class User(BaseModel): name: str = None; age: int

Solution

1. Step 1: Check required and optional fields syntax

   Required fields have type only, optional fields use Optional[type] with default None.

2. Step 2: Identify correct syntax

   class User(BaseModel): name: str; age: Optional[int] = None uses name: str (required) and age: Optional[int] = None (optional), which is correct.

3. Final Answer:

   class User(BaseModel): name: str; age: Optional[int] = None -> Option B

4. Quick Check:

   Optional fields use Optional[type] = None [OK]

Hint: Use Optional[type] = None for optional fields [OK]

Common Mistakes:

• Using plain type with default None without Optional
• Assigning type with equals sign incorrectly
• Setting required fields with default None

3. Given this Pydantic model:

from pydantic import BaseModel

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

item = Item(id='5', name='Book', price=12.99)

What will be the type of item.id after creation?

medium

A. TypeError raised

B. str with value '5'

C. float with value 5.0

D. int with value 5

Solution

1. Step 1: Understand Pydantic type coercion

   Pydantic automatically converts compatible types to the declared type if possible.

2. Step 2: Analyze input and conversion

   The string '5' can be converted to int 5, so item.id becomes int 5.

3. Final Answer:

   int with value 5 -> Option D

4. Quick Check:

   Pydantic converts compatible types automatically [OK]

Hint: Pydantic converts strings to int if possible [OK]

Common Mistakes:

• Assuming input type must match exactly without conversion
• Expecting a TypeError for string input
• Thinking the value stays as string

4. What is wrong with this Pydantic model definition?

from pydantic import BaseModel

class Product(BaseModel):
    name: str
    price: float = 'free'

medium

A. Missing import for Optional

B. Class must inherit from object, not BaseModel

C. Default value 'free' is a string but price expects a float

D. Field names cannot be lowercase

Solution

1. Step 1: Check field types and default values

   The field price expects a float but is given a string default 'free'.

2. Step 2: Understand Pydantic validation

   Pydantic will raise a validation error because 'free' cannot be converted to float.

3. Final Answer:

   Default value 'free' is a string but price expects a float -> Option C

4. Quick Check:

   Default value type must match field type [OK]

Hint: Default values must match declared field types [OK]

Common Mistakes:

• Assigning default values of wrong type
• Confusing inheritance requirements
• Thinking field names have naming restrictions

5. You want to create a Pydantic model User with a required username (string), an optional email (string), and a roles list of strings that defaults to an empty list. Which is the correct way to define it?

hard

A. class User(BaseModel): username: str; email: Optional[str] = None; roles: list[str] = Field(default_factory=list)

B. class User(BaseModel): username: str; email: str = None; roles: list[str] = []

C. class User(BaseModel): username: str; email: Optional[str]; roles: list[str] = None

D. class User(BaseModel): username: str; email: Optional[str] = None; roles: list[str] = []

Solution

1. Step 1: Identify optional email field syntax

   Email is optional, so use Optional[str] = None to allow missing value.

2. Step 2: Handle mutable default for roles list

   Using roles: list[str] = [] is unsafe because lists are mutable defaults shared across instances. Use Field(default_factory=list) to create a new list each time.

3. Final Answer:

   class User(BaseModel): username: str; email: Optional[str] = None; roles: list[str] = Field(default_factory=list) -> Option A

4. Quick Check:

   Use Field(default_factory=list) for mutable defaults [OK]

Hint: Use Field(default_factory=list) for empty list defaults [OK]

Common Mistakes:

• Using mutable empty list as default directly
• Not marking optional fields with Optional and default None
• Assigning None to non-optional list fields