Query parameter validation in FastAPI - Step-by-Step Execution

Concept Flow - Query parameter validation

Client sends request with query parameters

↓

FastAPI receives request

↓

Extract query parameters

↓

Validate parameters using type hints and constraints

↓

Process request

↓

Send response

FastAPI receives query parameters, checks if they meet the rules, then either processes the request or returns an error.

Execution Sample

FastAPI

from fastapi import FastAPI
from fastapi import Query

app = FastAPI()

@app.get("/items/")
async def read_items(q: str = Query(..., min_length=3, max_length=10)):
    return {"q": q}

This code defines a GET endpoint that requires a query parameter 'q' with length between 3 and 10 characters.

Execution Table

Step	Query Parameter 'q'	Validation Check	Result	Action
1	"ab"	Length >= 3?	False	Return error: 422 Unprocessable Entity
2	"abc"	Length >= 3 and <= 10?	True	Process request, return {"q": "abc"}
3	"abcdefghijk"	Length <= 10?	False	Return error: 422 Unprocessable Entity
4	Missing 'q'	Required parameter present?	False	Return error: 422 Unprocessable Entity

💡 Execution stops when validation fails or request is processed successfully.

Variable Tracker

Variable	Start	After Step 1	After Step 2	After Step 3	After Step 4
q	None	"ab"	"abc"	"abcdefghijk"	None
Validation Result	None	False	True	False	False

Key Moments - 3 Insights

Why does the request fail when 'q' is missing?

Because 'q' is required (no default), FastAPI returns a 422 error as shown in step 4 of the execution_table.

What happens if 'q' is shorter than 3 characters?

Validation fails due to min_length=3, so FastAPI returns a 422 error as shown in step 1.

Why does 'q' longer than 10 characters cause an error?

Because max_length=10 is set, exceeding it triggers validation failure and a 422 error as in step 3.

Visual Quiz - 3 Questions

Look at the execution_table, what is the validation result when 'q' is "abc"?

A True

B False

C Error

D None

💡 Hint

Check the 'Validation Check' and 'Result' columns at Step 2 in the execution_table.

At which step does the condition 'Length >= 3?' become false?

A Step 2

B Step 3

C Step 1

D Step 4

💡 Hint

Look at the 'Validation Check' and 'Result' columns in the execution_table.

If we remove min_length=3 from the Query, how would Step 1 change?

A Validation would still fail

B Validation would pass and request processed

C Error response would change to 404

D No change in behavior

💡 Hint

Refer to the validation rules in the execution_table and how min_length affects validation.

Concept Snapshot

FastAPI Query Parameter Validation:
- Use type hints and Query() to declare parameters
- Add constraints like min_length, max_length
- FastAPI auto-validates and returns 422 error if invalid
- Required parameters must be present
- Valid parameters proceed to handler function

Full Transcript

This visual execution shows how FastAPI handles query parameter validation. When a client sends a request with query parameters, FastAPI extracts and checks them against the declared rules. If the parameter 'q' is missing or does not meet length constraints, FastAPI returns a 422 error. If valid, the request is processed and the parameter value is returned. The execution table traces different inputs and their validation results step-by-step. Variable tracking shows how 'q' and validation results change. Key moments clarify common confusions about required parameters and length limits. The quiz tests understanding by referencing the execution steps and variable states.

Practice

1. What is the main purpose of using Query() in FastAPI for query parameters?

easy

A. To validate and enforce rules on query parameter values

B. To create new API endpoints automatically

C. To handle database connections

D. To format the response data

Solution

1. Step 1: Understand the role of Query()

   Query() is used in FastAPI to add validation rules to query parameters, such as minimum length or value ranges.

2. Step 2: Identify what Query() does not do

   It does not create endpoints, handle databases, or format responses; it only validates input parameters.

3. Final Answer:

   To validate and enforce rules on query parameter values -> Option A

4. Quick Check:

   Query() validates parameters = B [OK]

Hint: Query() is for input rules, not endpoints or data handling [OK]

Common Mistakes:

• Thinking Query() creates API routes
• Confusing Query() with response formatting
• Assuming Query() manages database connections

2. Which of the following is the correct syntax to require a query parameter q with a minimum length of 3 in FastAPI?

easy

A. Query(q: str, min_length=3)

B. q: Query = str(min_length=3)

C. q = Query(str, min_length=3)

D. q: str = Query(min_length=3)

Solution

1. Step 1: Recall FastAPI query parameter syntax

   In FastAPI, you declare a query parameter with its type and assign it to Query() with validation rules, e.g., q: str = Query(min_length=3).

2. Step 2: Check each option's syntax correctness

   q: str = Query(min_length=3) matches the correct pattern. Options B, C, and D misuse type annotations or function calls.

3. Final Answer:

   q: str = Query(min_length=3) -> Option D

4. Quick Check:

   Correct syntax = A [OK]

Hint: Type then = Query(...) with rules inside [OK]

Common Mistakes:

• Swapping type and Query() order
• Calling Query() incorrectly as a function
• Missing type annotation before Query()

3. Given this FastAPI endpoint code, what will be the response if the query parameter age is set to 15?

from fastapi import FastAPI, Query
app = FastAPI()

@app.get("/items/")
async def read_items(age: int = Query(..., ge=18)):
    return {"age": age}

medium

A. {"age": 15}

B. 422 Unprocessable Entity error

C. 500 Internal Server Error

D. {"age": null}

Solution

1. Step 1: Understand the validation rule

   The query parameter age requires a value greater or equal to 18 (ge=18).

2. Step 2: Check the input value against the rule

   Input age=15 is less than 18, so FastAPI will reject it with a 422 validation error.

3. Final Answer:

   422 Unprocessable Entity error -> Option B

4. Quick Check:

   age < 18 triggers 422 error = C [OK]

Hint: ge=18 means age must be 18 or more [OK]

Common Mistakes:

• Assuming invalid input returns null or default
• Expecting server error instead of validation error
• Ignoring validation and returning input as is

4. Identify the error in this FastAPI query parameter validation code:

from fastapi import FastAPI, Query
app = FastAPI()

@app.get("/search/")
async def search_items(q: str = Query(min_length=5)):
    return {"query": q}

medium

A. There is no error; the code correctly requires the query parameter with min_length validation

B. min_length should be max_length

C. Query() cannot be used with strings

D. Function must be synchronous, not async

Solution

1. Step 1: Check if query parameter is required

   Query(min_length=5) implicitly sets default=Ellipsis, making q required with string length validation.

2. Step 2: Understand FastAPI requirement for required params

   Explicit ... is not needed; the code correctly validates required query parameters. No error.

3. Final Answer:

   There is no error; the code correctly requires the query parameter with min_length validation -> Option A

4. Quick Check:

   Required param needs Query(...) = A [OK]

Hint: Query(min_length=5) makes param required implicitly [OK]

Common Mistakes:

• Thinking Query(min_length=5) makes param optional
• Confusing min_length with max_length
• Thinking async is invalid for FastAPI endpoints

5. You want to create a FastAPI endpoint that accepts a query parameter tags which must be a list of strings, each at least 2 characters long. Which is the correct way to validate this?

hard

A. tags: list[str] = Query(..., min_length=2)

B. tags: list[str] = Query(..., min_items=1, min_length=2)

C. tags: list[str] = Query(..., min_items=1), with custom validation for string length

D. tags: str = Query(..., min_length=2)

Solution

1. Step 1: Understand FastAPI's Query validation limits

   FastAPI's Query() supports min_items for lists but min_length applies to strings, not list elements.

2. Step 2: Validate list and individual string lengths

   To ensure each string in the list is at least 2 characters, you must add custom validation logic beyond Query().

3. Final Answer:

   tags: list[str] = Query(..., min_items=1), with custom validation for string length -> Option C

4. Quick Check:

   List length via Query, element length via custom code = D [OK]

Hint: Query() validates list size; use extra code for element rules [OK]

Common Mistakes:

• Using min_length on list instead of strings inside
• Not validating individual string lengths
• Declaring tags as a single string instead of list