Query parameter validation in FastAPI - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is query parameter validation in FastAPI?

It is the process of checking and enforcing rules on the data sent as query parameters in a URL to ensure they meet expected types and constraints before processing.

beginner

How do you declare a required query parameter in FastAPI?

By defining a function parameter without a default value or using Query(...) to explicitly mark it as required.

intermediate

What does the Query() function do in FastAPI?

It allows you to declare metadata and validation rules for query parameters, like default values, minimum or maximum length, and descriptions.

intermediate

How can you enforce a minimum and maximum value for a numeric query parameter in FastAPI?

Use Query() with parameters like ge (greater than or equal) and le (less than or equal) to set minimum and maximum limits.

beginner

What happens if a query parameter fails validation in FastAPI?

FastAPI automatically returns a clear error response with status code 422 and details about the validation failure.

Which FastAPI function is used to add validation rules to query parameters?

A Body()

B Path()

C Query()

D Header()

Query() is used to declare and validate query parameters in FastAPI.

How do you make a query parameter optional with a default value of 10?

A param: int

B param: int = Query(10)

C param: int = 10

D param: int = Query()

Using Query(10) sets the default value to 10 and makes the parameter optional.

What validation keyword enforces a minimum length for a string query parameter?

A min_length

B min_value

C length_min

D minsize

min_length is the correct keyword to set minimum string length in Query().

If a query parameter is missing but required, what status code does FastAPI return?

A 500

B 404

C 400

D 422

FastAPI returns 422 Unprocessable Entity for validation errors including missing required parameters.

Which of these is NOT a valid way to declare a query parameter in FastAPI?

A param: int = Body(...)

B param: int = 5

C param: int

D param: int = Query(..., ge=1, le=10)

Body() is used for request body parameters, not query parameters.

Explain how to validate a query parameter that must be an integer between 1 and 100 in FastAPI.

Think about using Query() with minimum and maximum value constraints.

Describe what happens when a client sends a query parameter that does not meet the validation rules in FastAPI.

Consider how FastAPI handles invalid input automatically.

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