Route ordering and priority in FastAPI - Interactive Code Practice

Practice - 5 Tasks

1fill in blank

easy

Complete the code to define a route that matches the path '/items'.

FastAPI

from fastapi import FastAPI
app = FastAPI()

@app.get("[1]")
def read_items():
    return {"message": "List of items"}

Drag options to blanks, or click blank then click option'

A/items/{item_id}

B/item/{id}

C/items

D/

Attempts:

3 left

💡 Hint

Common Mistakes

Using a path with parameters when the route should be static.

Forgetting the leading slash in the path.

The route decorator must match the exact path '/items' to handle requests to that path.

2fill in blank

medium

Complete the code to define a route that matches any item ID as a path parameter.

FastAPI

from fastapi import FastAPI
app = FastAPI()

@app.get("[1]")
def read_item(item_id: int):
    return {"item_id": item_id}

Drag options to blanks, or click blank then click option'

A/items/{item_id}

B/items

C/item/{id}

D/items/{id}

Attempts:

3 left

💡 Hint

Common Mistakes

Using a different parameter name in the path and function.

Omitting the curly braces around the parameter.

The route must include a path parameter in curly braces to capture the item ID.

3fill in blank

hard

Fix the error in the route order to ensure the static route '/users/me' is matched before the dynamic route.

FastAPI

from fastapi import FastAPI
app = FastAPI()

@app.get("/users/me")
def read_current_user():
    return {"user": "current user"}

@app.get("/users/[1]")
def read_user(user_id: str):
    return {"user_id": user_id}

Drag options to blanks, or click blank then click option'

Ame

B{id}

Ccurrent

D{user_id}

Attempts:

3 left

💡 Hint

Common Mistakes

Using 'me' as a parameter instead of a static path segment.

Defining the dynamic route before the static route.

The dynamic route must use a path parameter like '{user_id}' to capture any user ID, while the static route '/users/me' should be defined before it to take priority.

4fill in blank

hard

Fill both blanks to create a route that matches a file path with an extension and a route that matches a specific file name.

FastAPI

from fastapi import FastAPI
app = FastAPI()

@app.get("/files/[2]")
def read_readme():
    return {"file": "README file"}

@app.get("/files/[1]")
def read_file(file_path: str):
    return {"file_path": file_path}

Drag options to blanks, or click blank then click option'

A{file_path:path}

BREADME.md

C{filename}

DREADME

Attempts:

3 left

💡 Hint

Common Mistakes

Using a simple parameter without ':path' for file paths.

Not matching the exact file name in the static route.

The first route uses a path parameter with ':path' to capture any file path including slashes. The second route matches the exact file name 'README.md'.

5fill in blank

hard

Fill all three blanks to create a dictionary comprehension that maps route names to their handler functions only if the route name starts with 'get'.

FastAPI

routes = {
    [1]: [2] for [3] in route_list if [3].startswith('get')
}

Drag options to blanks, or click blank then click option'

Aroute_name

Bhandlers[route_name]

Droute

Attempts:

3 left

💡 Hint

Common Mistakes

Using different variable names inconsistently.

Not filtering routes starting with 'get'.

The comprehension uses 'route_name' as the key and 'handlers[route_name]' as the value, iterating over 'route_name' in 'route_list' and filtering names starting with 'get'.

Practice

1. In FastAPI, why is the order of route definitions important?

easy

A. Because FastAPI only matches routes defined after the first one.

B. Because FastAPI matches routes in the order they are added, affecting which route handles a request.

C. Because FastAPI automatically sorts routes alphabetically before matching.

D. Because FastAPI ignores route order and matches randomly.

Solution

1. Step 1: Understand FastAPI route matching

   FastAPI checks routes in the order they are added to decide which one handles a request.

2. Step 2: Importance of order

   If a general route is defined before a specific one, the general route will match first, possibly causing unexpected behavior.

3. Final Answer:

   Because FastAPI matches routes in the order they are added, affecting which route handles a request. -> Option B

4. Quick Check:

   Route order affects matching = C [OK]

Hint: Remember: FastAPI checks routes top to bottom [OK]

Common Mistakes:

• Thinking FastAPI sorts routes automatically
• Assuming route order doesn't matter
• Believing routes match randomly

2. Which of the following is the correct way to define routes to ensure the specific route /users/me is matched before the dynamic route /users/{user_id}?

easy

A. Define @app.get('/users/me') before @app.get('/users/{user_id}')

B. Define @app.get('/users/{user_id}') before @app.get('/users/me')

C. Define both routes in any order; FastAPI handles priority automatically

D. Use the same route for both and check inside the function

Solution

1. Step 1: Identify route specificity

   The route /users/me is more specific than the dynamic /users/{user_id}.

2. Step 2: Define specific route first

   To ensure /users/me matches correctly, it must be defined before the dynamic route.

3. Final Answer:

   Define @app.get('/users/me') before @app.get('/users/{user_id}') -> Option A

4. Quick Check:

   Specific routes first = B [OK]

Hint: Put fixed routes before dynamic ones [OK]

Common Mistakes:

• Defining dynamic routes before specific ones
• Assuming FastAPI auto-prioritizes routes
• Using same route for different purposes

3. Given the following FastAPI routes, what will be the response when a client requests /items/special?

from fastapi import FastAPI
app = FastAPI()

@app.get('/items/{item_id}')
async def read_item(item_id: str):
    return {'item_id': item_id}

@app.get('/items/special')
async def read_special():
    return {'message': 'Special item'}

medium

A. Raises a runtime error due to route conflict

B. Returns {'message': 'Special item'}

C. Raises a 404 Not Found error

D. Returns {'item_id': 'special'}

Solution

1. Step 1: Check route order

   The dynamic route /items/{item_id} is defined before the specific /items/special route.

2. Step 2: Understand matching behavior

   FastAPI matches routes in order, so /items/special matches the dynamic route first, returning {'item_id': 'special'}.

3. Final Answer:

   Returns {'item_id': 'special'} -> Option D

4. Quick Check:

   First match wins = A [OK]

Hint: First matching route handles request [OK]

Common Mistakes:

• Assuming specific route matches despite order
• Expecting 404 when dynamic route matches
• Thinking FastAPI detects conflicts automatically

4. You have these FastAPI routes:

@app.get('/products/{product_id}')
async def get_product(product_id: int):
    return {'product_id': product_id}

@app.get('/products/latest')
async def get_latest_product():
    return {'product': 'latest'}

When you request /products/latest, you get a 422 validation error. What is the likely cause?

medium

A. The function names conflict causing a runtime error.

B. The specific route /products/latest is missing a required parameter.

C. The dynamic route /products/{product_id} is defined before the specific route, causing FastAPI to try converting 'latest' to int and fail.

D. FastAPI does not support routes with similar prefixes.

Solution

1. Step 1: Analyze route order and parameter types

   The dynamic route with product_id: int is defined first, so FastAPI tries to match /products/latest here and convert 'latest' to int.

2. Step 2: Understand validation error cause

   Conversion fails because 'latest' is not an integer, causing a 422 error instead of matching the specific route.

3. Final Answer:

   The dynamic route /products/{product_id} is defined before the specific route, causing FastAPI to try converting 'latest' to int and fail. -> Option C

4. Quick Check:

   Dynamic route first with int param causes 422 = D [OK]

Hint: Define specific routes before typed dynamic routes [OK]

Common Mistakes:

• Ignoring route order impact on type conversion
• Assuming FastAPI tries all routes before error
• Confusing 422 with 404 errors

5. You want to create a FastAPI app with these routes: - /files/{file_path:path} to serve any file path dynamically - /files/download to trigger a download action How should you order these routes to ensure /files/download works correctly without being captured by the dynamic route?

hard

A. Define @app.get('/files/download') before @app.get('/files/{file_path:path}')

B. Define @app.get('/files/{file_path:path}') before @app.get('/files/download')

C. Define both routes in any order; FastAPI prioritizes static over dynamic automatically

D. Use a single route and check inside the function if path equals 'download'

Solution

1. Step 1: Understand path parameter behavior

   The {file_path:path} captures all paths under /files/, including 'download'.

2. Step 2: Place specific route first

   To ensure /files/download matches the specific route, define it before the dynamic catch-all route.

3. Final Answer:

   Define @app.get('/files/download') before @app.get('/files/{file_path:path}') -> Option A

4. Quick Check:

   Specific static route before catch-all = A [OK]

Hint: Put static routes before catch-all dynamic routes [OK]

Common Mistakes:

• Defining catch-all route before static route
• Assuming FastAPI auto-prioritizes static routes
• Using one route for different purposes without checks