Route ordering and priority in FastAPI - Step-by-Step Execution

Concept Flow - Route ordering and priority

Define routes in order

↓

Incoming request arrives

↓

Check first route pattern

↓

Run first route handler

No↓

Check next route pattern

↓

Run matched route handler

No↓

404 Not Found

FastAPI checks routes in the order they are defined. The first matching route handles the request. If none match, a 404 error is returned.

Execution Sample

FastAPI

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"}

Defines two routes: a dynamic route for any item_id and a specific route for '/items/special'. The order affects which handler runs for '/items/special'.

Execution Table

Step	Request Path	Route Checked	Match?	Handler Run	Response
1	/items/special	/items/{item_id}	Yes	read_item	{"item_id": "special"}
2	/items/special	/items/special	No	None	Not reached
3	/items/123	/items/{item_id}	Yes	read_item	{"item_id": "123"}
4	/items/123	/items/special	No	None	Not reached
5	/items/unknown	/items/{item_id}	Yes	read_item	{"item_id": "unknown"}
6	/items/unknown	/items/special	No	None	Not reached
7	/unknown	/items/{item_id}	No	None	Not matched
8	/unknown	/items/special	No	None	Not matched
9	/unknown	No more routes	N/A	None	404 Not Found

💡 Request handled by first matching route or returns 404 if none match.

Variable Tracker

Variable	Start	After Step 1	After Step 3	After Step 5	After Step 7	Final
request_path	None	/items/special	/items/123	/items/unknown	/unknown	/unknown
matched_route	None	/items/{item_id}	/items/{item_id}	/items/{item_id}	None	None
handler_run	None	read_item	read_item	read_item	None	None
response	None	{"item_id": "special"}	{"item_id": "123"}	{"item_id": "unknown"}	None	404 Not Found

Key Moments - 3 Insights

Why does the dynamic route '/items/{item_id}' handle the '/items/special' request instead of the specific '/items/special' route?

Because the dynamic route is defined before the specific route, FastAPI matches it first and stops checking further routes, as shown in execution_table step 1.

What happens if no route matches the incoming request path?

FastAPI returns a 404 Not Found error, as shown in execution_table step 9 where '/unknown' matches no routes.

How can we ensure the specific route '/items/special' handles requests to that path?

Define the specific route before the dynamic route so it matches first, preventing the dynamic route from capturing '/items/special'.

Visual Quiz - 3 Questions

Look at the execution_table, what handler runs for the request path '/items/special' at step 1?

A 404 Not Found

B read_item

C read_special

D None

💡 Hint

Check the 'Handler Run' column at step 1 in the execution_table.

At which step does the request path '/unknown' result in a 404 Not Found?

A Step 9

B Step 8

C Step 7

D Step 6

💡 Hint

Look for the row where 'Response' is '404 Not Found' in the execution_table.

If we move the '/items/special' route above '/items/{item_id}', what changes in the execution_table for '/items/special'?

A Step 1 still matches dynamic route and runs read_item

B No route matches and returns 404

C Step 1 matches '/items/special' route and runs read_special

D Both routes run for the same request

💡 Hint

Consider route order priority explained in concept_flow and key_moments.

Concept Snapshot

FastAPI matches routes in the order they are defined.
The first route pattern that matches the request path handles it.
Specific routes should be defined before dynamic ones to get priority.
If no route matches, FastAPI returns a 404 error.
Route order affects which handler runs for overlapping paths.

Full Transcript

In FastAPI, routes are checked in the order they are defined. When a request comes in, FastAPI looks at each route pattern one by one. If the request path matches a route, FastAPI runs that route's handler and stops checking further routes. If no routes match, it returns a 404 Not Found error. For example, if a dynamic route like '/items/{item_id}' is defined before a specific route like '/items/special', the dynamic route will handle requests to '/items/special' because it matches first. To give priority to specific routes, define them before dynamic routes. This ordering controls which handler runs for overlapping paths.

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