Custom error response models in FastAPI - Practice Problems & Coding Challenges

Challenge - 5 Problems

❓ component_behavior

intermediate

What is the output when a custom error response model is used in FastAPI?

Consider this FastAPI endpoint with a custom error response model:

from fastapi import FastAPI, HTTPException
from pydantic import BaseModel

app = FastAPI()

class ErrorResponse(BaseModel):
    detail: str

@app.get("/items/{item_id}", responses={404: {"model": ErrorResponse}})
async def read_item(item_id: int):
    if item_id != 42:
        raise HTTPException(status_code=404, detail="Item not found")
    return {"item_id": item_id, "name": "The Answer"}

What will the client receive if they request /items/1?

FastAPI

from fastapi import FastAPI, HTTPException
from pydantic import BaseModel

app = FastAPI()

class ErrorResponse(BaseModel):
    detail: str

@app.get("/items/{item_id}", responses={404: {"model": ErrorResponse}})
async def read_item(item_id: int):
    if item_id != 42:
        raise HTTPException(status_code=404, detail="Item not found")
    return {"item_id": item_id, "name": "The Answer"}

A {"error": "Item not found"} with status code 404

B {"detail": "Item not found"} with status code 404

C {"detail": "Not Found"} with status code 404

D {"message": "Item not found"} with status code 404

💡 Hint

Look at the ErrorResponse model and the detail field.

The custom error response model ErrorResponse defines a detail field. When the endpoint raises an HTTPException with status 404, FastAPI uses this model to format the response. So the client receives a JSON with {"detail": "Item not found"} and status code 404.

📝 Syntax

intermediate

Which option correctly defines a custom error response model in FastAPI?

Which of the following code snippets correctly defines a custom error response model for a 400 error in FastAPI?

A

@app.get("/users/{user_id}", responses={400: {"model": ErrorModel}})
async def get_user(user_id: int):
    pass

class ErrorModel(BaseModel):
    error: str

B

class ErrorModel(BaseModel):
    error: str

@app.get("/users/{user_id}", responses={"400": {"model": ErrorModel}})
async def get_user(user_id: int):
    pass

C

@app.get("/users/{user_id}", responses={"400": {"model": ErrorModel}})
async def get_user(user_id: int):
    pass

class ErrorModel(BaseModel):
    error: str

D

class ErrorModel(BaseModel):
    error: str

@app.get("/users/{user_id}", responses={400: {"model": ErrorModel}})
async def get_user(user_id: int):
    pass

💡 Hint

Remember to define the model before using it in the decorator.

In FastAPI, the Pydantic model must be defined before it is referenced in the responses parameter. Also, the status code keys in responses should be integers, not strings.

🔧 Debug

advanced

Why does this FastAPI custom error response model not show the expected field?

Given this code:

from fastapi import FastAPI, HTTPException
from pydantic import BaseModel

app = FastAPI()

class ErrorResponse(BaseModel):
    message: str

@app.get("/data", responses={404: {"model": ErrorResponse}})
async def get_data():
    raise HTTPException(status_code=404, detail="Data missing")

When requesting /data, the response JSON is {"detail": "Data missing"} instead of {"message": "Data missing"}. Why?

FastAPI

from fastapi import FastAPI, HTTPException
from pydantic import BaseModel

app = FastAPI()

class ErrorResponse(BaseModel):
    message: str

@app.get("/data", responses={404: {"model": ErrorResponse}})
async def get_data():
    raise HTTPException(status_code=404, detail="Data missing")

A The custom error response model is ignored unless you manually catch the exception and return it.

B The ErrorResponse model must have a 'detail' field to match the HTTPException detail key.

C FastAPI uses the HTTPException detail field as 'detail' key by default, ignoring the custom model's field name.

D The responses dictionary must use string keys for status codes to work properly.

💡 Hint

Think about how FastAPI formats HTTPException responses by default.

FastAPI automatically returns the detail field from HTTPException as the JSON key detail. The custom error response model only documents the response schema but does not change the actual response keys unless you handle the exception yourself.

❓ state_output

advanced

What is the output of this FastAPI endpoint with a custom error response model and manual exception handling?

Analyze this FastAPI code:

from fastapi import FastAPI, Request
from fastapi.responses import JSONResponse
from pydantic import BaseModel

app = FastAPI()

class ErrorResponse(BaseModel):
    message: str

@app.exception_handler(KeyError)
async def key_error_handler(request: Request, exc: KeyError):
    return JSONResponse(
        status_code=400,
        content={"message": f"Missing key: {exc.args[0]}"}
    )

@app.get("/items/{item_id}")
async def read_item(item_id: int):
    data = {"1": "apple", "2": "banana"}
    return {"item": data[str(item_id)]}

What will be the JSON response and status code if the client requests /items/3?

FastAPI

from fastapi import FastAPI, Request
from fastapi.responses import JSONResponse
from pydantic import BaseModel

app = FastAPI()

class ErrorResponse(BaseModel):
    message: str

@app.exception_handler(KeyError)
async def key_error_handler(request: Request, exc: KeyError):
    return JSONResponse(
        status_code=400,
        content={"message": f"Missing key: {exc.args[0]}"}
    )

@app.get("/items/{item_id}")
async def read_item(item_id: int):
    data = {"1": "apple", "2": "banana"}
    return {"item": data[str(item_id)]}

A {"message": "Missing key: 3"} with status code 400

B {"detail": "KeyError"} with status code 400

C 500 Internal Server Error with no JSON response

D {"item": null} with status code 200

💡 Hint

Consider what happens when the key is missing in the dictionary and how the exception handler works.

Requesting /items/3 causes a KeyError because '3' is not in the dictionary. The custom exception handler catches this and returns a JSON response with the message and status code 400.

🧠 Conceptual

expert

Which statement best describes the role of custom error response models in FastAPI?

Choose the most accurate description of how custom error response models work in FastAPI.

A They serve primarily as documentation and validation for error responses, but actual response content depends on exception handling.

B They automatically transform raised exceptions into JSON responses matching the model's fields without extra code.

C They replace the default HTTPException behavior and require no manual exception handlers to customize error output.

D They enforce that all error responses must have the exact fields defined in the model, or else FastAPI raises an error.

💡 Hint

Think about what FastAPI does automatically and what requires manual coding.

Custom error response models in FastAPI mainly document the expected error response schema for OpenAPI and client generation. They do not automatically change the response content unless you write custom exception handlers.