Optional query parameters in FastAPI - Performance & Optimization

Performance: Optional query parameters

MEDIUM IMPACT

This affects the server response time and the amount of data processed before sending the response, impacting initial load and interaction speed.

Handling optional query parameters in API endpoints

FastAPI

from fastapi import FastAPI
from typing import Optional

app = FastAPI()

@app.get("/items")
async def read_items(q: Optional[str] = None):
    if q:
        return {"q": q}
    return {"message": "No query provided"}

Declaring the query parameter as optional allows the server to handle requests smoothly without extra error handling.

📈 Performance GainReduces server processing time for requests without the parameter, improving response speed.

Handling optional query parameters in API endpoints

FastAPI

from fastapi import FastAPI
from typing import Optional

app = FastAPI()

@app.get("/items")
async def read_items(q: str):
    # q is expected but optional is not declared
    return {"q": q}

The query parameter is not optional, so requests without it cause errors or require extra validation, increasing server load.

📉 Performance CostBlocks response for all requests missing the parameter, causing unnecessary error handling overhead.

Performance Comparison

Pattern	Server Processing	Error Handling	Response Time	Verdict
Required query parameter without default	High (validates every request)	High (errors on missing param)	Slower due to error handling	[X] Bad
Optional query parameter with default None	Low (skips validation if missing)	None (no errors on missing param)	Faster response for missing param	[OK] Good

Rendering Pipeline

Optional query parameters affect the server-side processing stage before the response is sent to the browser. Efficient handling reduces server CPU time and network latency.

→Server Processing

→Network Transfer

⚠️ BottleneckServer Processing when validating and handling query parameters

Core Web Vital Affected

INP

This affects the server response time and the amount of data processed before sending the response, impacting initial load and interaction speed.

Optimization Tips

1Declare query parameters as optional with default None when they are not always needed.

2Avoid unnecessary validation by using optional parameters to reduce server load.

3Test API response times with and without optional parameters to ensure performance gains.

Performance Quiz - 3 Questions

What is the main performance benefit of using optional query parameters in FastAPI?

A Reduces server error handling and speeds up response for missing parameters

B Increases server validation to ensure all parameters are present

C Adds extra network overhead by sending default values

D Blocks rendering until all parameters are validated

DevTools: Network

How to check: Open DevTools, go to Network tab, send requests with and without query parameters, and compare response times.

What to look for: Look for faster response times and fewer error status codes (like 422) when optional parameters are used correctly.

Practice

1. What does it mean when a query parameter in FastAPI is optional?

easy

A. The parameter is required but can be empty

B. The parameter must always be included in the request

C. The user can choose to include it or not in the request

D. The parameter is ignored by FastAPI

Solution

1. Step 1: Understand optional parameters in APIs

   Optional means the user does not have to provide the parameter for the request to work.

2. Step 2: Apply to FastAPI query parameters

   FastAPI allows parameters to be optional by giving them a default value like None.

3. Final Answer:

   The user can choose to include it or not in the request -> Option C

4. Quick Check:

   Optional query parameter = user choice [OK]

Hint: Optional means user may skip it without error [OK]

Common Mistakes:

• Thinking optional means parameter is always required
• Confusing optional with ignored parameters
• Assuming optional means empty string is required

2. Which of the following is the correct way to declare an optional query parameter named q of type str in FastAPI?

easy

A. def read_items(q: Optional[str] = None):

B. def read_items(q: str = None):

C. def read_items(q: str):

D. def read_items(q: Optional[str]):

Solution

1. Step 1: Recall syntax for optional query parameters

   FastAPI uses Optional[type] with a default value None to mark parameters optional.

2. Step 2: Check each option

   def read_items(q: Optional[str] = None): uses Optional[str] and default None, which is correct syntax.

3. Final Answer:

   def read_items(q: Optional[str] = None): -> Option A

4. Quick Check:

   Optional[str] + = None = correct syntax [OK]

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

Common Mistakes:

• Omitting the default None value
• Using Optional without import
• Setting type to str without Optional

3. Given this FastAPI endpoint code:

from typing import Optional
from fastapi import FastAPI

app = FastAPI()

@app.get("/items/")
async def read_items(q: Optional[str] = None):
    if q:
        return {"query": q}
    return {"query": "No query"}

What will be the JSON response when the client calls /items/ without any query parameters?

medium

A. {"query": null}

B. {"query": "No query"}

C. An error occurs because q is missing

D. {"query": ""}

Solution

1. Step 1: Understand default value of q

   q is Optional[str] with default None, so if missing, q is None.

2. Step 2: Check the if condition

   If q is None (falsey), the function returns {"query": "No query"}.

3. Final Answer:

   {"query": "No query"} -> Option B

4. Quick Check:

   Missing q returns "No query" [OK]

Hint: Missing optional param uses default None [OK]

Common Mistakes:

• Expecting error when param is missing
• Assuming null is returned instead of string
• Confusing empty string with None

4. Identify the error in this FastAPI endpoint code that tries to make q optional:

from fastapi import FastAPI

app = FastAPI()

@app.get("/search/")
def search(q: str = None):
    return {"q": q}

medium

A. q should be typed as Optional[str] when default is None

B. Function must be async to use optional parameters

C. Missing import of Optional from typing

D. Default value None is not allowed for query parameters

Solution

1. Step 1: Check parameter typing and default

   q has type str but default None, which conflicts because None is not str.

2. Step 2: Correct typing for optional parameter

   Use Optional[str] from typing to allow None as a valid default.

3. Final Answer:

   q should be typed as Optional[str] when default is None -> Option A

4. Quick Check:

   Type must match default None with Optional[str] [OK]

Hint: Match type with default None using Optional[type] [OK]

Common Mistakes:

• Not importing Optional but using it
• Making function async unnecessarily
• Using None default without Optional type

5. You want to create a FastAPI endpoint that accepts an optional integer query parameter page with a default of 1, but if the user sends page=0, it should return an error. How would you declare page to achieve this behavior?

hard

A. page: Optional[int] = 1 with extra validation to reject 0

B. page: int without default and require user to send page > 0

C. page: Optional[int] = None and set page = 1 inside function if None

D. page: int = 1 and check inside function if page == 0 to raise error

Solution

1. Step 1: Understand default and validation needs

   Default 1 means page is not optional, but user can omit it to get 1.

2. Step 2: Handle invalid value 0

   Use int with default 1, then inside function check if page == 0 and raise error.

3. Final Answer:

   page: int = 1 and check inside function if page == 0 to raise error -> Option D

4. Quick Check:

   Default + validation inside function = page: int = 1 and check inside function if page == 0 to raise error [OK]

Hint: Use default param + check value inside function [OK]

Common Mistakes:

• Making page Optional[int] = 1 (invalid syntax)
• Not validating 0 value inside function
• Requiring page without default when default needed