Protected routes in FastAPI - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is a protected route in FastAPI?

A protected route is an API endpoint that requires the user to be authenticated before accessing it. It prevents unauthorized users from reaching sensitive data or actions.

beginner

How do you protect a route in FastAPI?

You protect a route by adding a dependency that checks the user's authentication, usually with OAuth2 or a token. If the user is not authenticated, FastAPI returns an error and blocks access.

intermediate

What is the role of OAuth2PasswordBearer in FastAPI protected routes?

OAuth2PasswordBearer is a class that helps FastAPI extract a token from the request header. It is used as a dependency to get the token, which you then verify to check if the user has access to protected routes.

beginner

Why should protected routes return 401 Unauthorized status code when access is denied?

Returning 401 Unauthorized tells the client that authentication is required or failed. This helps clients understand they need to log in or provide valid credentials to access the route.

intermediate

What is a common pattern to reuse authentication logic across multiple protected routes in FastAPI?

A common pattern is to create a reusable dependency function that verifies the user token and returns the current user. This function is then added as a dependency to any route that needs protection.

Which FastAPI feature is commonly used to protect routes by checking user authentication?

A Dependencies

B Middleware

C Background tasks

D Static files

Dependencies allow you to run code before the route handler, such as checking authentication.

What HTTP status code should a protected route return if the user is not authenticated?

A 404 Not Found

B 200 OK

C 403 Forbidden

D 401 Unauthorized

401 Unauthorized means the user must authenticate to access the resource.

In FastAPI, OAuth2PasswordBearer is used to:

A Serve static files

B Send emails

C Extract and validate a token from the request

D Handle database connections

OAuth2PasswordBearer extracts the token from the Authorization header for validation.

What happens if a protected route's dependency raises an HTTPException with status 401?

A FastAPI returns a 401 response and blocks access

B The route executes normally

C The server crashes

D The client is redirected automatically

Raising HTTPException with 401 stops the route and returns an error response.

To protect multiple routes with the same authentication logic, you should:

A Repeat the authentication code in each route

B Use a reusable dependency function

C Use global variables

D Use a different FastAPI app for each route

Reusable dependencies keep code clean and consistent for authentication.

Explain how to implement a protected route in FastAPI using OAuth2PasswordBearer.

Think about how FastAPI dependencies help check authentication before route runs.

Describe why protected routes are important in web APIs and how FastAPI helps secure them.

Consider the role of authentication and status codes in security.

Practice

1. What is the main purpose of protected routes in FastAPI?

easy

A. To automatically generate API documentation

B. To speed up the API response time

C. To allow anyone to access all endpoints without restrictions

D. To restrict access to certain endpoints by verifying user credentials

Solution

1. Step 1: Understand what protected routes do

   Protected routes limit access to certain parts of an app by checking if the user is allowed.

2. Step 2: Identify the correct purpose

   Only To restrict access to certain endpoints by verifying user credentials describes restricting access by verifying user credentials, which matches protected routes.

3. Final Answer:

   To restrict access to certain endpoints by verifying user credentials -> Option D

4. Quick Check:

   Protected routes = restrict access [OK]

Hint: Protected routes check user access before allowing endpoint use [OK]

Common Mistakes:

• Thinking protected routes improve speed
• Confusing protected routes with documentation features
• Assuming protected routes allow open access

2. Which FastAPI feature is commonly used to enforce protected routes by requiring token verification?

easy

A. BackgroundTasks

B. Depends

C. Query

D. Path

Solution

1. Step 1: Recall FastAPI dependency injection

   FastAPI uses Depends to declare dependencies like authentication checks.

2. Step 2: Match feature to protected routes

   Using Depends with a function that verifies tokens enforces protection on routes.

3. Final Answer:

   Depends -> Option B

4. Quick Check:

   Token check uses Depends [OK]

Hint: Use Depends to add token checks on routes [OK]

Common Mistakes:

• Confusing Depends with query or path parameters
• Using BackgroundTasks for authentication
• Not using any dependency for protection

3. Given this FastAPI code snippet, what will happen when accessing /users/me without a token?

from fastapi import FastAPI, Depends, HTTPException
from fastapi.security import OAuth2PasswordBearer

app = FastAPI()
oauth2_scheme = OAuth2PasswordBearer(tokenUrl="token")

def get_current_user(token: str = Depends(oauth2_scheme)):
    if token != "validtoken":
        raise HTTPException(status_code=401, detail="Invalid token")
    return {"username": "user1"}

@app.get("/users/me")
async def read_users_me(current_user: dict = Depends(get_current_user)):
    return current_user

medium

A. Raises HTTP 401 Unauthorized error

B. Returns {"username": "user1"} regardless of token

C. Returns an empty response

D. Raises HTTP 404 Not Found error

Solution

1. Step 1: Analyze token dependency behavior

   The function get_current_user checks if the token equals "validtoken"; otherwise, it raises HTTP 401.

2. Step 2: Consider no token case

   Without a token, oauth2_scheme will not provide a valid token, so the check fails and raises HTTP 401.

3. Final Answer:

   Raises HTTP 401 Unauthorized error -> Option A

4. Quick Check:

   No token = HTTP 401 error [OK]

Hint: No valid token triggers HTTP 401 error [OK]

Common Mistakes:

• Assuming it returns user data without token
• Confusing 401 with 404 error
• Expecting empty response instead of error

4. Identify the error in this FastAPI protected route code:

from fastapi import FastAPI, Depends, HTTPException
from fastapi.security import OAuth2PasswordBearer

app = FastAPI()
oauth2_scheme = OAuth2PasswordBearer(tokenUrl="token")

def get_current_user(token: str):
    if token != "secret":
        raise HTTPException(status_code=401, detail="Unauthorized")
    return {"user": "admin"}

@app.get("/dashboard")
async def dashboard(user: dict = Depends(get_current_user)):
    return user

medium

A. OAuth2PasswordBearer is not imported

B. HTTPException is not imported

C. Missing Depends in get_current_user parameter

D. Route path is invalid

Solution

1. Step 1: Check get_current_user parameter

   The function expects token: str but does not use Depends(oauth2_scheme) to get the token automatically.

2. Step 2: Identify missing dependency injection

   Without Depends(oauth2_scheme), FastAPI won't provide the token, causing an error.

3. Final Answer:

   Missing Depends in get_current_user parameter -> Option C

4. Quick Check:

   Token param needs Depends(oauth2_scheme) [OK]

Hint: Use Depends(oauth2_scheme) to get token in dependencies [OK]

Common Mistakes:

• Forgetting to import HTTPException
• Not using Depends for token parameter
• Incorrect route path syntax

5. How can you combine FastAPI's OAuth2PasswordBearer with a custom user verification function to protect multiple routes efficiently?

hard

A. Create a reusable dependency function that uses OAuth2PasswordBearer to get the token and verifies the user, then use Depends on routes

B. Add token verification code inside each route handler separately

C. Use OAuth2PasswordBearer only in the main app instance without dependencies

D. Skip token verification and rely on client-side checks

Solution

1. Step 1: Understand reusable dependency pattern

   Creating a function that uses OAuth2PasswordBearer to get the token and verifies the user allows reuse across routes.

2. Step 2: Apply Depends to routes

   Using Depends with this function on multiple routes enforces protection without repeating code.

3. Final Answer:

   Create a reusable dependency function that uses OAuth2PasswordBearer to get the token and verifies the user, then use Depends on routes -> Option A

4. Quick Check:

   Reusable dependency + Depends = efficient protection [OK]

Hint: Make one verify function and reuse with Depends on routes [OK]

Common Mistakes:

• Duplicating token checks in every route
• Not using Depends for token verification
• Ignoring server-side token checks