HTTPException usage in FastAPI - Step-by-Step Execution

Concept Flow - HTTPException usage

Request received

↓

Check condition

↓

Raise HTTPException

↓

Client receives response

When a request comes in, the code checks a condition. If the condition is true, it raises an HTTPException to send an error response. Otherwise, it returns a normal response.

Execution Sample

FastAPI

from fastapi import FastAPI, HTTPException
app = FastAPI()

@app.get('/items/{item_id}')
async def read_item(item_id: int):
    if item_id < 1:
        raise HTTPException(status_code=400, detail='Invalid ID')
    return {'item_id': item_id}

This code checks if the item_id is less than 1. If yes, it raises an HTTPException with status 400. Otherwise, it returns the item_id.

Execution Table

Step	Input item_id	Condition (item_id < 1)	Action	Output/Response
1	0	True	Raise HTTPException(400, 'Invalid ID')	HTTP 400 Bad Request with detail 'Invalid ID'
2	1	False	Return {'item_id': 1}	{'item_id': 1}
3	5	False	Return {'item_id': 5}	{'item_id': 5}
4	-3	True	Raise HTTPException(400, 'Invalid ID')	HTTP 400 Bad Request with detail 'Invalid ID'

💡 Execution stops after raising HTTPException or returning the response.

Variable Tracker

Variable	Start	After Step 1	After Step 2	After Step 3	After Step 4
item_id	N/A	0	1	5	-3
Condition (item_id < 1)	N/A	True	False	False	True

Key Moments - 2 Insights

Why does the function stop running after raising HTTPException?

Because raising HTTPException immediately interrupts the function and sends an error response, no further code runs after that (see Step 1 and Step 4 in execution_table).

What happens if the condition is false?

If the condition is false, the function returns a normal response dictionary with the item_id (see Step 2 and Step 3 in execution_table).

Visual Quiz - 3 Questions

Look at the execution table, what is the output when item_id is 0?

A HTTP 200 OK with empty body

B HTTP 400 Bad Request with detail 'Invalid ID'

C {'item_id': 0}

D Function returns None

💡 Hint

Check Step 1 in the execution_table where item_id is 0.

At which step does the condition item_id < 1 become false?

A Step 4

B Step 1

C Step 2

D None

💡 Hint

Look at the Condition column in execution_table for each step.

If we change the condition to item_id <= 0, how would the output change for item_id = 1?

A It would return {'item_id': 1}

B It would raise HTTPException

C It would return None

D It would cause a syntax error

💡 Hint

Check how the condition affects item_id values in variable_tracker and execution_table.

Concept Snapshot

Use HTTPException in FastAPI to send error responses.
Check a condition in your path operation.
If condition true, raise HTTPException with status_code and detail.
Otherwise, return normal response.
Raising HTTPException stops function execution and sends error to client.

Full Transcript

This example shows how FastAPI uses HTTPException to handle errors. When a request comes in with an item_id, the code checks if item_id is less than 1. If yes, it raises HTTPException with status 400 and a message 'Invalid ID'. This stops the function and sends an error response to the client. If the item_id is valid (1 or more), the function returns a dictionary with the item_id. The execution table shows different inputs and what happens step by step. The variable tracker shows how item_id and the condition change. Key moments explain why raising HTTPException stops the function and what happens when the condition is false. The quiz questions help check understanding of these steps.

Practice

1. What is the main purpose of using HTTPException in FastAPI?

easy

A. To create database models automatically

B. To define API routes

C. To handle user authentication

D. To send HTTP error responses with a status code and message

Solution

1. Step 1: Understand HTTPException role

   HTTPException is designed to send HTTP error responses with specific status codes and messages.

2. Step 2: Compare with other options

   Other options like database models, authentication, or route definition are unrelated to HTTPException's purpose.

3. Final Answer:

   To send HTTP error responses with a status code and message -> Option D

4. Quick Check:

   HTTPException = send error response [OK]

Hint: HTTPException sends errors, not data or routes [OK]

Common Mistakes:

• Confusing HTTPException with route creation
• Thinking it manages database or authentication
• Using it to send successful responses

2. Which of the following is the correct way to raise an HTTP 404 error with a message in FastAPI?

easy

A. return HTTPException(404, "Item not found")

B. raise HTTPException(status_code=404, detail="Item not found")

C. HTTPException(404, detail="Item not found")

D. raise HTTPException(404, message="Item not found")

Solution

1. Step 1: Check correct syntax for raising HTTPException

   The correct syntax uses raise HTTPException(status_code=404, detail="Item not found").

2. Step 2: Identify errors in other options

   return HTTPException(404, "Item not found") wrongly uses return instead of raise. HTTPException(404, detail="Item not found") misses raise keyword. raise HTTPException(404, message="Item not found") uses incorrect keyword 'message' instead of 'detail'.

3. Final Answer:

   raise HTTPException(status_code=404, detail="Item not found") -> Option B

4. Quick Check:

   Use raise + status_code + detail [OK]

Hint: Always use raise with status_code and detail keys [OK]

Common Mistakes:

• Using return instead of raise
• Missing status_code or detail keywords
• Using wrong keyword like message

3. What will happen when this FastAPI endpoint is called and the item is not found?

from fastapi import FastAPI, HTTPException
app = FastAPI()

items = {"apple": "A juicy fruit"}

@app.get("/items/{item_name}")
async def read_item(item_name: str):
    if item_name not in items:
        raise HTTPException(status_code=404, detail="Item not found")
    return {"item": items[item_name]}

medium

A. The API returns the string 'Item not found'

B. The API returns an empty JSON response

C. The API returns a 404 error with message 'Item not found'

D. The API crashes with a server error

Solution

1. Step 1: Analyze the condition for missing item

   If the requested item_name is not in the items dictionary, the code raises HTTPException with status 404 and detail message.

2. Step 2: Understand FastAPI behavior on HTTPException

   FastAPI catches HTTPException and sends an HTTP response with the given status code and detail message as JSON.

3. Final Answer:

   The API returns a 404 error with message 'Item not found' -> Option C

4. Quick Check:

   Missing item triggers HTTPException 404 [OK]

Hint: Missing item triggers HTTPException with 404 [OK]

Common Mistakes:

• Expecting empty or string response instead of error
• Thinking the server crashes
• Ignoring the raise keyword effect

4. Identify the error in this FastAPI code snippet:

from fastapi import FastAPI, HTTPException
app = FastAPI()

@app.get("/users/{user_id}")
def get_user(user_id: int):
    if user_id < 0:
        HTTPException(status_code=400, detail="Invalid user ID")
    return {"user_id": user_id}

medium

A. Missing raise keyword before HTTPException

B. Incorrect status_code value for error

C. user_id should be a string, not int

D. The endpoint path is invalid

Solution

1. Step 1: Check how HTTPException is used

   The code calls HTTPException but does not use raise, so the exception is not actually raised.

2. Step 2: Verify other parts

   Status code 400 is valid for bad request. user_id as int is correct. Endpoint path syntax is valid.

3. Final Answer:

   Missing raise keyword before HTTPException -> Option A

4. Quick Check:

   Always use raise before HTTPException [OK]

Hint: Use raise before HTTPException to trigger error [OK]

Common Mistakes:

• Calling HTTPException without raise
• Using wrong status codes for errors
• Confusing parameter types

5. You want to create a FastAPI endpoint that returns a 403 Forbidden error with a custom message if a user is not an admin. Which code snippet correctly implements this?

hard

A. if not is_admin:
raise HTTPException(status_code=403, detail="Access denied: Admins only")

B. if not is_admin:
return HTTPException(status_code=403, detail="Access denied: Admins only")

C. if not is_admin:
raise HTTPException(403, message="Access denied: Admins only")

D. if not is_admin:
HTTPException(status_code=403, detail="Access denied: Admins only")

Solution

1. Step 1: Check correct way to raise HTTPException with 403

   The correct way is to use raise with status_code=403 and detail message.

2. Step 2: Identify errors in other options

   if not is_admin: return HTTPException(status_code=403, detail="Access denied: Admins only") uses return instead of raise, so no error is raised. if not is_admin: raise HTTPException(403, message="Access denied: Admins only") uses wrong keyword 'message'. if not is_admin: HTTPException(status_code=403, detail="Access denied: Admins only") calls HTTPException without raise, so no exception is triggered.

3. Final Answer:

   if not is_admin: raise HTTPException(status_code=403, detail="Access denied: Admins only") -> Option A

4. Quick Check:

   Use raise + status_code + detail for errors [OK]

Hint: Raise HTTPException with status_code and detail for errors [OK]

Common Mistakes:

• Using return instead of raise
• Wrong keyword 'message' instead of 'detail'
• Calling HTTPException without raise