Path operation dependencies in FastAPI

Introduction

Path operation dependencies help you run shared code before your API handles a request. This keeps your code clean and avoids repeating yourself.

You want to check if a user is logged in before allowing access to certain pages.

You need to connect to a database before processing a request.

You want to validate or transform input data for many routes.

You want to add common headers or security checks to multiple endpoints.

Syntax

FastAPI

from fastapi import FastAPI, Depends

app = FastAPI()

def common_dependency():
    # code to run before path operation
    return 'some value'

@app.get('/items/')
async def read_items(dep_value: str = Depends(common_dependency)):
    return {'dep_value': dep_value}

Use Depends() to declare a dependency in a path operation function.

The dependency function runs first and its return value is passed to the path operation.

Examples

This example runs verify_token before the route and passes its result.

FastAPI

from fastapi import FastAPI, Depends

app = FastAPI()

def verify_token():
    return 'token verified'

@app.get('/secure')
async def secure_route(token_status: str = Depends(verify_token)):
    return {'status': token_status}

Dependency can also accept parameters and return values used in the path operation.

FastAPI

from fastapi import FastAPI, Depends

app = FastAPI()

def common_params(q: str | None = None):
    return q

@app.get('/search')
async def search(q: str | None = Depends(common_params)):
    return {'query': q}

Sample Program

This program defines a dependency get_token_header that runs before the /items/ route. The route receives the token value and returns it in the response.

FastAPI

from fastapi import FastAPI, Depends

app = FastAPI()

def get_token_header():
    # Imagine checking a token here
    return 'token123'

@app.get('/items/')
async def read_items(token: str = Depends(get_token_header)):
    return {'token_received': token}

Important Notes

Dependencies can be reused in many routes to keep code DRY (Don't Repeat Yourself).

You can stack multiple dependencies by adding more parameters with Depends().

Dependencies can also raise errors to stop request processing early.

Summary

Path operation dependencies run shared code before handling requests.

Use Depends() to declare dependencies in your route functions.

This helps keep your API code clean and organized.

Practice

1. What is the main purpose of using Depends() in FastAPI path operations?

easy

A. To create a new database connection manually

B. To define the HTTP method for the route

C. To specify the response status code

D. To run shared code before handling requests

Solution

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

   Depends() is used to declare dependencies that run shared code before the main path operation function executes.

2. Step 2: Identify the purpose in FastAPI

   This helps keep code clean by reusing common logic like authentication or database access.

3. Final Answer:

   To run shared code before handling requests -> Option D

4. Quick Check:

   Depends() runs shared code before requests [OK]

Hint: Depends() runs shared code before request handling [OK]

Common Mistakes:

• Thinking Depends() sets HTTP methods
• Confusing Depends() with response status codes
• Assuming Depends() manually creates DB connections

2. Which of the following is the correct way to declare a dependency in a FastAPI path operation function?

easy

A. def read_item(item_id: int, user=Depends[get_current_user]):

B. def read_item(item_id: int, user=Depends):

C. def read_item(item_id: int, user=Depends(get_current_user)):

D. def read_item(item_id: int, user=get_current_user()):

Solution

1. Step 1: Recall the syntax for dependencies

   Dependencies are declared by assigning a parameter to Depends() with the dependency function inside.

2. Step 2: Check each option

   def read_item(item_id: int, user=Depends(get_current_user)): correctly uses user=Depends(get_current_user). Others have syntax errors or call the function directly.

3. Final Answer:

   def read_item(item_id: int, user=Depends(get_current_user)): -> Option C

4. Quick Check:

   Depends() with function inside parentheses [OK]

Hint: Use Depends(function_name) with parentheses [OK]

Common Mistakes:

• Calling the dependency function directly
• Using Depends without parentheses
• Using square brackets instead of parentheses

3. Given the code below, what will be the output when accessing /items/5?

from fastapi import FastAPI, Depends

app = FastAPI()

def get_token():
    return "token123"

@app.get("/items/{item_id}")
def read_item(item_id: int, token: str = Depends(get_token)):
    return {"item_id": item_id, "token": token}

medium

A. {"item_id": 5, "token": "token123"}

B. {"item_id": 5, "token": null}

C. RuntimeError due to missing token parameter

D. SyntaxError in dependency declaration

Solution

1. Step 1: Understand dependency execution

   The get_token function returns "token123" and is injected into token parameter via Depends().

2. Step 2: Check the returned dictionary

   The path operation returns a dictionary with item_id and token keys, so the output includes the token string.

3. Final Answer:

   {"item_id": 5, "token": "token123"} -> Option A

4. Quick Check:

   Dependency injects token value correctly [OK]

Hint: Depends injects return value as parameter [OK]

Common Mistakes:

• Expecting token to be null without dependency
• Thinking dependency causes runtime error
• Confusing syntax with runtime errors

4. Identify the error in the following FastAPI code using dependencies:

from fastapi import FastAPI, Depends

app = FastAPI()

def get_user():
    return "user1"

@app.get("/profile")
def profile(user: str = Depends(get_user)):
    return {"user": user}

@app.get("/dashboard")
def dashboard(user = Depends(get_user)):
    return {"dashboard_user": user}

medium

A. Missing type annotation for 'user' in dashboard function

B. Depends() used incorrectly without parentheses

C. get_user function missing return statement

D. Path operation decorator missing on dashboard function

Solution

1. Step 1: Compare both path operation functions

   The profile function declares user: str = Depends(get_user) with a type annotation.

2. Step 2: Identify the issue in dashboard

   The dashboard function uses user = Depends(get_user) but lacks a type annotation, which FastAPI requires for dependencies.

3. Final Answer:

   Missing type annotation for 'user' in dashboard function -> Option A

4. Quick Check:

   Dependency parameters need type annotations [OK]

Hint: Always add type annotations for Depends parameters [OK]

Common Mistakes:

• Omitting type annotations on dependency parameters
• Forgetting parentheses on Depends()
• Assuming missing decorator causes error

5. You want to reuse a dependency that extracts a user from a token and also check if the user is active before allowing access to multiple routes. How should you combine these checks using FastAPI dependencies?

hard

A. Create two separate dependency functions and use Depends() on both in the path operation

B. Call the user extraction function inside the active check function and use Depends() only on the active check

C. Use a single dependency function that returns user without any checks

D. Use Depends() only on the user extraction function and check active status inside each path operation

Solution

1. Step 1: Understand dependency chaining

   You can call one dependency inside another to reuse logic and combine checks.

2. Step 2: Apply chaining for user extraction and active check

   By calling the user extraction inside the active check dependency, you only need to use Depends() on the active check in routes.

3. Final Answer:

   Call the user extraction function inside the active check function and use Depends() only on the active check -> Option B

4. Quick Check:

   Chain dependencies by calling one inside another [OK]

Hint: Chain dependencies by calling one inside another [OK]

Common Mistakes:

• Using multiple Depends() separately causing repeated calls
• Not chaining dependencies and duplicating code
• Checking user active status outside dependencies