Why request bodies carry structured data in FastAPI - Performance Evidence

Performance: Why request bodies carry structured data

MEDIUM IMPACT

This affects the network payload size and server processing time during API calls, impacting page load and interaction speed.

Sending data from client to server in an API call

FastAPI

POST /api/data HTTP/1.1
Content-Type: application/json

{"name":"John","age":30,"city":"NY"}

Structured JSON allows fast automatic parsing and smaller, predictable payloads.

📈 Performance Gainreduces server CPU parsing time and optimizes network payload size

Sending data from client to server in an API call

FastAPI

POST /api/data HTTP/1.1
Content-Type: text/plain

The user's name is John, age is 30, city is NY

Using unstructured plain text forces manual parsing and can increase errors and processing time.

📉 Performance Costadds unnecessary server CPU parsing time and can increase payload size

Performance Comparison

Pattern	Payload Size	Server Parsing Cost	Network Efficiency	Verdict
Unstructured plain text	Larger due to encoding	High due to manual parsing	Low	[X] Bad
Structured JSON	Smaller and predictable	Low due to automatic parsing	High	[OK] Good

Rendering Pipeline

Structured request bodies are parsed by the server before generating a response, affecting server processing and response time.

→Network Transfer

→Server Parsing

→Response Generation

⚠️ BottleneckServer Parsing stage is most expensive if data is unstructured or large.

Core Web Vital Affected

INP

This affects the network payload size and server processing time during API calls, impacting page load and interaction speed.

Optimization Tips

1Always use structured formats like JSON for request bodies to optimize parsing.

2Set Content-Type header correctly to enable fast server processing.

3Avoid sending large unstructured text to reduce server load and network delay.

Performance Quiz - 3 Questions

Why is sending structured data in request bodies better for performance?

A It allows faster server parsing and smaller payloads

B It increases payload size but reduces server load

C It blocks rendering on the client side

D It reduces the number of HTTP requests

DevTools: Network

How to check: Open DevTools, go to Network tab, inspect the request payload size and content type of API calls.

What to look for: Look for Content-Type as application/json and smaller payload size for better performance.

Practice

1. Why do request bodies in FastAPI usually carry structured data like JSON objects?

easy

A. To make the request body smaller in size

B. To allow the server to understand and validate the data easily

C. To hide the data from the client

D. To speed up the network connection

Solution

1. Step 1: Understand the purpose of structured data in requests

   Structured data like JSON helps the server know exactly what information it is receiving.

2. Step 2: Recognize the benefit of validation

   Using structured data allows FastAPI to validate the data automatically, ensuring it is correct and complete.

3. Final Answer:

   To allow the server to understand and validate the data easily -> Option B

4. Quick Check:

   Structured data = clear server understanding [OK]

Hint: Structured data helps servers read and check data easily [OK]

Common Mistakes:

• Thinking structured data hides information
• Believing it reduces request size
• Assuming it speeds up network

2. Which of the following is the correct way to declare a request body using a Pydantic model in FastAPI?

easy

A. def create_item(item: dict):

B. def create_item(item: int):

C. def create_item(item: str):

D. def create_item(item: Item):

Solution

1. Step 1: Identify the use of Pydantic models

   FastAPI uses Pydantic models to define structured request bodies, so the parameter type should be a model class like Item.

2. Step 2: Check the parameter type

   Using a dict or primitive types like str or int does not provide validation or structure automatically.

3. Final Answer:

   def create_item(item: Item): -> Option D

4. Quick Check:

   Use Pydantic model type for request body [OK]

Hint: Use Pydantic model class as parameter type [OK]

Common Mistakes:

• Using dict instead of a Pydantic model
• Using primitive types for complex data
• Not importing or defining the model

3. Given this FastAPI endpoint and Pydantic model:

from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()

class User(BaseModel):
    name: str
    age: int

@app.post('/users/')
async def create_user(user: User):
    return {"message": f"User {user.name} is {user.age} years old"}

What will be the response if the client sends:

{"name": "Alice", "age": 30}

medium

A. Validation error because age is not a string

B. {"message": "User 30 is Alice years old"}

C. {"message": "User Alice is 30 years old"}

D. Empty response with status 204

Solution

1. Step 1: Understand the model and endpoint

   The User model expects a name (string) and age (integer). The endpoint returns a message using these values.

2. Step 2: Check the input data

   The input JSON matches the model: name is "Alice" (string), age is 30 (int), so validation passes.

3. Final Answer:

   {"message": "User Alice is 30 years old"} -> Option C

4. Quick Check:

   Valid input returns formatted message [OK]

Hint: Match input types to model fields for success [OK]

Common Mistakes:

• Confusing field order in output
• Expecting validation error for correct types
• Assuming empty or error response

4. What is wrong with this FastAPI endpoint that expects a request body?

from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()

class Product(BaseModel):
    id: int
    name: str

@app.post('/products/')
def add_product(product: Product):
    return product

medium

A. There is no problem; the code is correct

B. The Product model fields are not typed correctly

C. The endpoint function is missing async keyword

D. The endpoint function should be async to handle requests properly

Solution

1. Step 1: Check function signature

   FastAPI supports both async and normal functions for endpoints. Missing async is allowed.

2. Step 2: Verify model and return

   The Product model is correctly typed, and returning the model instance is valid and will be serialized.

3. Final Answer:

   There is no problem; the code is correct -> Option A

4. Quick Check:

   Sync endpoint with Pydantic model is valid [OK]

Hint: Async is optional; sync functions work too [OK]

Common Mistakes:

• Thinking async is mandatory for endpoints
• Assuming model fields need special types
• Expecting error when returning model instance

5. You want to create a FastAPI endpoint that accepts a request body with a list of items, each having a name and quantity. Which approach correctly uses structured data to achieve this?

hard

A. Define a Pydantic model for an item and use List[Item] as the parameter type

B. Use a plain list of dictionaries without a Pydantic model

C. Accept a single string with comma-separated item names

D. Use multiple query parameters for each item

Solution

1. Step 1: Understand the need for structured data

   Each item has multiple fields (name and quantity), so a Pydantic model defines this structure clearly.

2. Step 2: Use a list of these models for multiple items

   Using List[Item] as the parameter type allows FastAPI to validate each item in the list properly.

3. Final Answer:

   Define a Pydantic model for an item and use List[Item] as the parameter type -> Option A

4. Quick Check:

   List of models = structured, validated data [OK]

Hint: Use List of Pydantic models for multiple structured items [OK]

Common Mistakes:

• Skipping Pydantic models for complex data
• Using plain lists without validation
• Trying to pass complex data via query parameters