Async path operations in FastAPI - Mini Project: Build & Apply

Async Path Operations with FastAPI

📖 Scenario: You are building a simple web API using FastAPI to handle user data asynchronously. This API will have endpoints to get user information and add new users without blocking the server.

🎯 Goal: Create a FastAPI app with asynchronous path operations to get a list of users and add a new user asynchronously.

📋 What You'll Learn

Create a FastAPI app instance named app

Create an initial list called users with two user names: 'alice' and 'bob'

Add a configuration variable max_users set to 5

Create an async GET path operation at /users that returns the users list

Create an async POST path operation at /users that accepts a username string and adds it to users if the list length is less than max_users

💡 Why This Matters

🌍 Real World

APIs often need to handle multiple requests at the same time without waiting. Using async path operations in FastAPI helps build fast and scalable web services.

💼 Career

Understanding async path operations is essential for backend developers working with modern Python web frameworks like FastAPI to build efficient APIs.

1

Create initial data and FastAPI app

Create a FastAPI app instance called app and a list called users with the exact entries 'alice' and 'bob'.

FastAPI

from fastapi import FastAPI

# Create FastAPI app instance and initial users list
# Your code here

Hint

Use app = FastAPI() to create the app and assign the list ['alice', 'bob'] to users.

2

Add configuration variable

Add a variable called max_users and set it to the integer 5.

FastAPI

from fastapi import FastAPI

app = FastAPI()

users = ['alice', 'bob']

# Add max_users variable here
# Your code here

Hint

Simply write max_users = 5 below the users list.

3

Create async GET path operation

Create an async GET path operation at /users using the decorator @app.get("/users"). Define an async function called get_users that returns the users list.

FastAPI

from fastapi import FastAPI

app = FastAPI()

users = ['alice', 'bob']

max_users = 5

# Create async GET path operation for /users
# Your code here

Hint

Use @app.get("/users") decorator and define async def get_users(): that returns users.

4

Create async POST path operation to add user

Create an async POST path operation at /users using @app.post("/users"). Define an async function called add_user that accepts a parameter username: str. Inside the function, check if the length of users is less than max_users. If yes, append username to users and return a dictionary {"message": "User added"}. Otherwise, return {"message": "User limit reached"}.

FastAPI

from fastapi import FastAPI

app = FastAPI()

users = ['alice', 'bob']

max_users = 5

@app.get("/users")
async def get_users():
    return users

# Create async POST path operation to add a user
# Your code here

Hint

Use @app.post("/users") and define async def add_user(username: str):. Check the length of users and append if below max_users.

Practice

1. What is the main benefit of using async def for path operations in FastAPI?

easy

A. It makes the code run faster by using multiple CPU cores automatically.

B. It allows the app to handle many requests at the same time without waiting.

C. It forces the app to run all requests one after another in order.

D. It disables the use of await inside the function.

Solution

1. Step 1: Understand async behavior in FastAPI

   Using async def allows the server to pause on waiting tasks and handle other requests meanwhile.

2. Step 2: Compare options

   It allows the app to handle many requests at the same time without waiting. correctly describes this concurrency benefit. Options B, C, and D are incorrect because async does not automatically use multiple CPU cores, does not force sequential execution, and does not disable await.

3. Final Answer:

   It allows the app to handle many requests at the same time without waiting. -> Option B

4. Quick Check:

   Async = concurrent handling [OK]

Hint: Async means handling many requests without waiting [OK]

Common Mistakes:

• Thinking async uses multiple CPU cores automatically
• Believing async forces sequential request handling
• Confusing async with disabling await

2. Which of the following is the correct way to define an async path operation in FastAPI?

easy

A. async def read_item(): return {'item': 'value'}

B. def read_item(): return {'item': 'value'}

C. async read_item(): return {'item': 'value'}

D. def async read_item(): return {'item': 'value'}

Solution

1. Step 1: Recall async function syntax in Python

   Async functions must be declared with async def followed by the function name and parentheses.

2. Step 2: Check each option

   async def read_item(): return {'item': 'value'} uses the correct syntax. def read_item(): return {'item': 'value'} is a normal function, not async. async read_item(): return {'item': 'value'} misses def. def async read_item(): return {'item': 'value'} incorrectly places async after def.

3. Final Answer:

   async def read_item(): return {'item': 'value'} -> Option A

4. Quick Check:

   Async function = async def [OK]

Hint: Async functions start with 'async def' [OK]

Common Mistakes:

• Omitting 'def' after 'async'
• Placing 'async' after 'def'
• Using normal def instead of async def

3. Given this FastAPI async path operation, what will be the output when calling /wait?

from fastapi import FastAPI
import asyncio
app = FastAPI()

@app.get('/wait')
async def wait_seconds():
    await asyncio.sleep(1)
    return {'message': 'Done waiting'}

medium

A. Immediate {'message': 'Done waiting'} without delay

B. Empty response with status 204

C. Error because asyncio.sleep cannot be awaited

D. {'message': 'Done waiting'} after 1 second delay

Solution

1. Step 1: Understand await with asyncio.sleep

   The function pauses for 1 second asynchronously before returning the message.

2. Step 2: Determine output behavior

   After 1 second delay, the JSON response {'message': 'Done waiting'} is returned. No error occurs because asyncio.sleep is awaitable.

3. Final Answer:

   {'message': 'Done waiting'} after 1 second delay -> Option D

4. Quick Check:

   Await sleep = delayed response [OK]

Hint: Await asyncio.sleep pauses before response [OK]

Common Mistakes:

• Thinking response is immediate without delay
• Assuming asyncio.sleep is not awaitable
• Expecting empty or error response

4. Identify the error in this FastAPI async path operation:

from fastapi import FastAPI
app = FastAPI()

@app.get('/data')
def get_data():
    await fetch_data()
    return {'status': 'ok'}

medium

A. Missing async keyword before function definition

B. Missing await keyword before fetch_data()

C. fetch_data() is not defined

D. Return statement is outside the function

Solution

1. Step 1: Check function declaration with await usage

   Using await inside a function requires the function to be declared with async def.

2. Step 2: Identify the error

   The function is declared with normal def but uses await, causing a syntax error. Missing async keyword before function definition correctly identifies this.

3. Final Answer:

   Missing async keyword before function definition -> Option A

4. Quick Check:

   Await needs async def [OK]

Hint: Await inside function needs async def [OK]

Common Mistakes:

• Forgetting to add async before def
• Thinking await can be used in normal functions
• Ignoring that fetch_data() might be undefined (not focus here)

5. You want to create an async FastAPI path operation that fetches user data from a database asynchronously and returns it. Which code snippet correctly combines async path operation with awaiting a database call?

hard

A. def get_user():
user = await fetch_user_from_db()
return user

B. def get_user():
user = fetch_user_from_db()
return user

C. async def get_user():
user = await fetch_user_from_db()
return user

D. async def get_user():
user = fetch_user_from_db()
return user

Solution

1. Step 1: Understand async and await usage

   To await an async database call, the function must be async and use await before the call.

2. Step 2: Analyze each option

   async def get_user(): user = await fetch_user_from_db() return user correctly uses async def and await. def get_user(): user = fetch_user_from_db() return user is synchronous and misses await. async def get_user(): user = fetch_user_from_db() return user is async but misses await. def get_user(): user = await fetch_user_from_db() return user uses await in a normal function, which is invalid.

3. Final Answer:

   async def get_user(): user = await fetch_user_from_db() return user -> Option C

4. Quick Check:

   Async def + await call = correct pattern [OK]

Hint: Async function must await async calls inside [OK]

Common Mistakes:

• Using await in non-async functions
• Forgetting to await async calls
• Mixing sync and async code incorrectly