Required query parameters in FastAPI - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is a required query parameter in FastAPI?

A required query parameter is a value that the client must provide in the URL query string for the API endpoint to work. FastAPI enforces this by not giving a default value to the parameter.

beginner

How do you declare a required query parameter in FastAPI?

You declare a required query parameter by adding a function argument without a default value in your path operation function. For example: def read_items(q: str): means 'q' is required.

beginner

What happens if a required query parameter is missing in a FastAPI request?

FastAPI automatically returns a 422 Unprocessable Entity error with a message explaining that the required query parameter is missing.

beginner

Can you make a query parameter optional in FastAPI? How?

Yes, by giving the query parameter a default value like None. For example: def read_items(q: str | None = None): makes 'q' optional.

beginner

Why are required query parameters useful in APIs?

They ensure the client provides necessary information for the API to work correctly, preventing errors and making the API behavior predictable.

In FastAPI, how do you make a query parameter required?

A By adding it to the URL path

B By not giving it a default value in the function signature

C By using @required decorator

D By setting it to None

In FastAPI, a query parameter without a default value is required.

What HTTP status code does FastAPI return if a required query parameter is missing?

A 500 Internal Server Error

B 404 Not Found

C 400 Bad Request

D 422 Unprocessable Entity

FastAPI returns 422 Unprocessable Entity when required query parameters are missing.

Which of these makes a query parameter optional in FastAPI?

A q: str = None

B q: str

C q: int

D q: str = ''

Setting a default value like None makes the query parameter optional.

If you want a query parameter 'page' to be required and an integer, how would you declare it?

A def read(page: str):

B def read(page: int = 1):

C def read(page: int):

D def read(page: int | None = None):

Declaring 'page' as int without a default value makes it required.

What is the main benefit of required query parameters?

A They ensure clients send necessary data

B They hide data from clients

C They make the API slower

D They make parameters optional

Required query parameters ensure clients provide needed information for the API to work.

Explain how to declare and use required query parameters in FastAPI.

Think about how function parameters work in Python and how FastAPI uses them.

Describe what happens when a client calls a FastAPI endpoint without providing a required query parameter.

Consider how FastAPI handles validation automatically.

Practice

1. In FastAPI, how do you make a query parameter required so the client must provide it in the URL?

easy

A. Use Optional type hint

B. Set the parameter default to None

C. Use Query(...) in the function parameter

D. Use Body(...) instead of query

Solution

1. Step 1: Understand FastAPI query parameters

   FastAPI uses function parameters to define query parameters automatically.

2. Step 2: Use Query(...) to require parameter

   Using Query(...) tells FastAPI this parameter is required and must be in the URL.

3. Final Answer:

   Use Query(...) in the function parameter -> Option C

4. Quick Check:

   Required query parameter = Query(...) [OK]

Hint: Use Query(...) to make query parameters required [OK]

Common Mistakes:

• Setting default to None makes parameter optional
• Using Optional type hint allows missing parameter
• Using Body(...) defines body, not query parameter

2. Which of the following is the correct syntax to declare a required query parameter named item_id of type int in FastAPI?

easy

A. def read_item(item_id: int = Query(None)):

B. def read_item(item_id: int = None):

C. def read_item(item_id: int = Body(...)):

D. def read_item(item_id: int = Query(...)):

Solution

1. Step 1: Identify required query parameter syntax

   To make a query parameter required, use Query(...) as the default value.

2. Step 2: Check each option

   def read_item(item_id: int = Query(...)): uses Query(...) correctly, making item_id required. def read_item(item_id: int = Query(None)): uses Query(None) which makes it optional. def read_item(item_id: int = None): uses default None without Query, optional. def read_item(item_id: int = Body(...)): uses Body(...) which makes it a required body field, not query parameter.

3. Final Answer:

   def read_item(item_id: int = Query(...)): -> Option D

4. Quick Check:

   Required query param = Query(...) [OK]

Hint: Use Query(...) as default to require query parameter [OK]

Common Mistakes:

• Using Query(None) makes parameter optional
• Using Body(...) for query parameter
• Setting default None makes parameter optional

3. Given this FastAPI endpoint code:

from fastapi import FastAPI, Query
app = FastAPI()

@app.get("/items/")
async def read_items(q: str = Query(...)):
    return {"query": q}

What happens if a client calls /items/ without the q query parameter?

medium

A. Returns HTTP 422 error for missing required query parameter

B. Returns HTTP 404 not found error

C. Returns empty JSON {}

D. Returns JSON with {"query": null}

Solution

1. Step 1: Understand Query(...) behavior

   Using Query(...) makes the parameter required. If missing, FastAPI returns an error automatically.

2. Step 2: Check what error FastAPI returns

   FastAPI returns HTTP 422 Unprocessable Entity error when a required query parameter is missing.

3. Final Answer:

   Returns HTTP 422 error for missing required query parameter -> Option A

4. Quick Check:

   Missing required query param = HTTP 422 error [OK]

Hint: Missing required query param causes HTTP 422 error [OK]

Common Mistakes:

• Expecting null or empty JSON instead of error
• Confusing 404 not found with parameter error
• Assuming optional parameter behavior

4. Identify the error in this FastAPI code snippet that tries to require a query parameter name:

from fastapi import FastAPI, Query
app = FastAPI()

@app.get("/users/")
async def get_user(name: str = Query(None)):
    return {"user": name}

medium

A. Missing type hint for name

B. The parameter is optional, not required

C. Query(...) should be replaced with Query(None)

D. Function should not be async

Solution

1. Step 1: Analyze Query parameter default

   The code uses Query(None) which means the parameter is optional.

2. Step 2: Check requirement for required parameter

   To make it required, it should use Query(...) instead of Query(None).

3. Final Answer:

   The parameter is optional, not required -> Option B

4. Quick Check:

   Query(None) = optional parameter [OK]

Hint: Query(None) means optional; use Query(...) for required [OK]

Common Mistakes:

• Confusing Query(None) with required parameter
• Ignoring type hints
• Thinking async keyword affects parameter requirement

5. You want to create a FastAPI endpoint that requires two query parameters: category (string) and limit (integer). Both must be required. Which code snippet correctly enforces this?

hard

A. async def get_items(category: str = Query(...), limit: int = Query(...)):

B. async def get_items(category: str = None, limit: int = None):

C. async def get_items(category: str, limit: int = Query(None)):

D. async def get_items(category: str = Query(None), limit: int = Query(...)):

Solution

1. Step 1: Understand required query parameters

   Both parameters must use Query(...) to be required.

2. Step 2: Evaluate each option

   async def get_items(category: str = Query(...), limit: int = Query(...)): correctly uses Query(...) for both. async def get_items(category: str = None, limit: int = None) uses None defaults, making them optional. async def get_items(category: str, limit: int = Query(None)) makes only limit optional. async def get_items(category: str = Query(None), limit: int = Query(...)) makes category optional.

3. Final Answer:

   async def get_items(category: str = Query(...), limit: int = Query(...)): -> Option A

4. Quick Check:

   Both required = Query(...) for each [OK]

Hint: Use Query(...) for each required query parameter [OK]

Common Mistakes:

• Setting default None makes parameter optional
• Mixing required and optional unintentionally
• Omitting Query makes parameter a path parameter