Example data in schema in FastAPI - Performance & Optimization

Performance: Example data in schema

MEDIUM IMPACT

This affects the speed of API response serialization and validation during request handling.

Providing example data in API schema for documentation and validation

FastAPI

from pydantic import BaseModel

class User(BaseModel):
    id: int
    name: str
    bio: str = "Short bio"

    class Config:
        schema_extra = {
            "example": {
                "id": 1,
                "name": "Alice",
                "bio": "Short bio"
            }
        }

Smaller example data reduces schema size and speeds up serialization and validation.

📈 Performance Gainreduces startup block by 80+ ms, response serialization faster by 15+ ms

Providing example data in API schema for documentation and validation

FastAPI

from pydantic import BaseModel

class User(BaseModel):
    id: int
    name: str
    bio: str = """A very long biography text repeated many times to simulate large example data..."""

    class Config:
        schema_extra = {
            "example": {
                "id": 1,
                "name": "Alice",
                "bio": "A very long biography text repeated many times to simulate large example data..."
            }
        }

Large example data increases schema size and slows down JSON serialization and validation during API startup and request handling.

📉 Performance Costblocks startup for 100+ ms, increases response serialization time by 20 ms

Performance Comparison

Pattern	Schema Size	Validation Time	Serialization Time	Verdict
Large example data	Large (10+ KB)	High (blocks startup)	High (adds 20ms)	[X] Bad
Minimal example data	Small (<1 KB)	Low (fast startup)	Low (adds <5ms)	[OK] Good

Rendering Pipeline

Example data in schema affects the API server's JSON serialization and validation steps before sending the response to the client.

→Validation

→Serialization

⚠️ BottleneckSerialization of large example data increases CPU time and memory usage.

Optimization Tips

1Keep example data small to reduce serialization time.

2Avoid very large strings or nested objects in examples.

3Use representative but minimal data for faster API startup and response.

Performance Quiz - 3 Questions

How does large example data in FastAPI schema affect API performance?

A It increases serialization and validation time, slowing response.

B It reduces network latency by compressing data.

C It improves startup time by caching schemas.

D It has no impact on performance.

DevTools: Network

How to check: Open DevTools, go to Network tab, inspect API response payload size and timing.

What to look for: Look for large JSON payload sizes and longer response times indicating heavy serialization.