Optional and nullable fields in FastAPI - Mini Project: Build & Apply

Optional and Nullable Fields in FastAPI

📖 Scenario: You are building a simple API to register users. Some user details are optional or can be empty.

🎯 Goal: Create a FastAPI app with a user model that has optional and nullable fields, and an endpoint to receive user data.

📋 What You'll Learn

Create a Pydantic model called User with required, optional, and nullable fields

Use Optional and None correctly for optional and nullable fields

Create a POST endpoint /users/ that accepts a User model

Return the received user data as JSON

💡 Why This Matters

🌍 Real World

APIs often receive data where some fields are optional or can be empty. Handling optional and nullable fields correctly is important for flexible and robust APIs.

💼 Career

Understanding how to use Pydantic models with optional and nullable fields is essential for backend developers working with FastAPI or similar frameworks.

1

Create the User model with required fields

Create a Pydantic model called User with two required fields: username of type str and email of type str.

FastAPI

from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()

# Create User model with required fields username and email
# Your code here

Hint

Use class User(BaseModel): and define username: str and email: str inside.

2

Add an optional field with default value

Add an optional field called full_name of type str to the User model. It should default to None using Optional[str].

FastAPI

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

app = FastAPI()

class User(BaseModel):
    username: str
    email: str
    # Add optional full_name field here
    # Your code here

Hint

Use full_name: Optional[str] = None to make the field optional and nullable.

3

Add a nullable field explicitly allowing None

Add a field called bio of type str to the User model. It should allow None values explicitly by using Optional[str] and default to None.

FastAPI

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

app = FastAPI()

class User(BaseModel):
    username: str
    email: str
    full_name: Optional[str] = None
    # Add nullable bio field here
    # Your code here

Hint

Use bio: Optional[str] = None to allow the field to be null.

4

Create POST endpoint to receive User data

Create a POST endpoint /users/ that accepts a User model as JSON body and returns the same User data as response.

FastAPI

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

app = FastAPI()

class User(BaseModel):
    username: str
    email: str
    full_name: Optional[str] = None
    bio: Optional[str] = None

# Create POST endpoint /users/ here
# Your code here

Hint

Use @app.post("/users/") decorator and define an async function create_user that takes user: User and returns it.

Practice

1. In FastAPI, what does it mean when a field is declared as Optional[str] in a request model?

easy

A. The field is required and cannot be None.

B. The field must always be provided with a string value.

C. The field can only be an empty string but not None.

D. The field can be omitted or set to None in the request.

Solution

1. Step 1: Understand Optional type in FastAPI

   Optional[str] means the field can be missing or have a value of type str or None.

2. Step 2: Interpret the meaning for API requests

   This allows clients to omit the field or explicitly send null (None) as its value.

3. Final Answer:

   The field can be omitted or set to None in the request. -> Option D

4. Quick Check:

   Optional[str] = omitted or None [OK]

Hint: Optional means field can be missing or None [OK]

Common Mistakes:

• Thinking Optional means field is always required
• Confusing Optional with default values
• Assuming Optional forbids None

2. Which of the following is the correct way to declare a nullable string field in a FastAPI Pydantic model?

easy

A. name: Optional[str] = None

B. name: str | None = None

C. name: str = None

D. name: str?

Solution

1. Step 1: Recall Pydantic syntax for optional and nullable fields

   To allow a field to be nullable and optional, use Optional[str] with a default None.

2. Step 2: Check each option

   A is invalid because just assigning None to str without Optional is not correct. B is valid Python 3.10+ syntax but C is the recommended explicit way in FastAPI. D is invalid syntax.

3. Final Answer:

   name: Optional[str] = None -> Option A

4. Quick Check:

   Nullable string = Optional[str] = None [OK]

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

Common Mistakes:

• Using just type with = None without Optional
• Using invalid syntax like str?
• Confusing Optional with just default values

3. Given this FastAPI model:

from typing import Optional
from pydantic import BaseModel

class User(BaseModel):
    name: str
    nickname: Optional[str] = None

user = User(name='Alice')

What will be the value of user.nickname?

medium

A. '' (empty string)

B. 'Alice'

C. None

D. Raises an error

Solution

1. Step 1: Analyze the model fields and defaults

   The nickname field is Optional[str] with a default of None, so if not provided, it defaults to None.

2. Step 2: Check the instance creation

   When creating user with only name='Alice', nickname is not set, so it uses the default None.

3. Final Answer:

   None -> Option C

4. Quick Check:

   Optional field missing = None [OK]

Hint: Missing optional field defaults to None [OK]

Common Mistakes:

• Assuming nickname defaults to empty string
• Thinking nickname copies name value
• Expecting an error for missing optional field

4. What is wrong with this FastAPI model declaration?

from typing import Optional
from pydantic import BaseModel

class Item(BaseModel):
    description: Optional[str]

medium

A. Optional[str] is not allowed in Pydantic models.

B. Missing default value for Optional field causes validation error.

C. Field description must be declared as str, not Optional[str].

D. No import for Optional is present.

Solution

1. Step 1: Understand Optional fields in Pydantic

   Optional means the field can be None or missing, but Pydantic requires a default value for optional fields.

2. Step 2: Check the model declaration

   The field description is Optional[str] but has no default value, so Pydantic will expect it to be provided and raise an error if missing.

3. Final Answer:

   Missing default value for Optional field causes validation error. -> Option B

4. Quick Check:

   Optional fields need default values [OK]

Hint: Optional fields must have default values [OK]

Common Mistakes:

• Omitting default None for Optional fields
• Thinking Optional alone makes field optional
• Ignoring Pydantic validation rules

5. You want to create a FastAPI model where the field email can be omitted, but if present, it can be set to null explicitly. Which is the best way to declare this field?

hard

A. email: Optional[str] = None

B. email: str = None

C. email: str | None

D. email: Optional[str]

Solution

1. Step 1: Understand requirements for the field

   The field must be optional (can be omitted) and nullable (can be None explicitly).

2. Step 2: Evaluate each declaration

   B lacks Optional and default None, so it is not optional. C lacks default None, so field is required. D lacks default None, so field is required. A uses Optional[str] with default None, making it optional and nullable.

3. Final Answer:

   email: Optional[str] = None -> Option A

4. Quick Check:

   Optional with default None = optional and nullable [OK]

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

Common Mistakes:

• Forgetting to assign default None
• Using union without default value
• Assuming Optional alone makes field optional