Custom response classes in FastAPI - Mini Project: Build & Apply

Custom Response Classes in FastAPI

📖 Scenario: You are building a simple FastAPI web service that returns different types of responses. You want to learn how to create and use custom response classes to control how your API sends data back to clients.

🎯 Goal: Build a FastAPI app that uses a custom response class to send plain text responses with a specific media type.

📋 What You'll Learn

Create a FastAPI app instance named app

Define a custom response class named PlainTextResponse that inherits from fastapi.responses.Response

Set the media type of PlainTextResponse to text/plain

Create a GET endpoint /hello that returns a PlainTextResponse with the text Hello, FastAPI!

💡 Why This Matters

🌍 Real World

Custom response classes let you control exactly how your API sends data back. This is useful when you want to send plain text, HTML, files, or other formats with specific headers.

💼 Career

Understanding custom response classes is important for backend developers working with FastAPI or similar frameworks to build APIs that meet client needs and standards.

1

Create the FastAPI app instance

Import FastAPI from fastapi and create an app instance called app.

FastAPI

from fastapi import FastAPI

# Create the FastAPI app instance
# Your code here

Hint

Use app = FastAPI() to create the app instance.

2

Define a custom response class

Import Response from fastapi.responses and create a class called PlainTextResponse that inherits from Response. Set its media_type attribute to "text/plain".

FastAPI

from fastapi import FastAPI
from fastapi.responses import Response

app = FastAPI()

# Define the custom response class
# Your code here

Hint

Define a class that inherits from Response and set media_type inside it.

3

Create a GET endpoint using the custom response

Create a GET endpoint at path /hello using @app.get("/hello"). Define a function called hello that returns a PlainTextResponse with the content "Hello, FastAPI!".

FastAPI

from fastapi import FastAPI
from fastapi.responses import Response

app = FastAPI()

class PlainTextResponse(Response):
    media_type = "text/plain"

# Create the GET endpoint
# Your code here

Hint

Use @app.get("/hello") to create the route and return the custom response with the text.

4

Add response class to endpoint decorator

Modify the @app.get decorator on the hello function to include the parameter response_class=PlainTextResponse.

FastAPI

from fastapi import FastAPI
from fastapi.responses import Response

app = FastAPI()

class PlainTextResponse(Response):
    media_type = "text/plain"

# Modify the decorator to include response_class
# Your code here

Hint

Add response_class=PlainTextResponse inside the @app.get decorator parentheses.

Practice

1. What is the main purpose of using Custom response classes in FastAPI?

easy

A. To handle user authentication

B. To create database models automatically

C. To control how FastAPI sends data back to the client

D. To manage background tasks

Solution

1. Step 1: Understand the role of response classes

   Response classes in FastAPI define how data is formatted and sent back to the client, such as JSON, HTML, or plain text.

2. Step 2: Identify the correct purpose

   Custom response classes let you control the exact format and headers of the response, improving clarity and compatibility.

3. Final Answer:

   To control how FastAPI sends data back to the client -> Option C

4. Quick Check:

   Custom response classes = control response format [OK]

Hint: Response classes define output format in FastAPI [OK]

Common Mistakes:

• Confusing response classes with database models
• Thinking they handle authentication
• Assuming they manage background tasks

2. Which of the following is the correct way to use a custom response class to return plain text in FastAPI?

easy

A. return PlainTextResponse(content="Hello World")

B. return JSONResponse(content="Hello World")

C. return HTMLResponse(content=123)

D. return FileResponse(path="hello.txt")

Solution

1. Step 1: Identify the correct response class for plain text

   FastAPI provides PlainTextResponse to send plain text content.

2. Step 2: Check the usage syntax

   The correct syntax is to pass the text string as the content argument.

3. Final Answer:

   return PlainTextResponse(content="Hello World") -> Option A

4. Quick Check:

   PlainTextResponse with content string = return PlainTextResponse(content="Hello World") [OK]

Hint: Use PlainTextResponse for text content [OK]

Common Mistakes:

• Using JSONResponse for plain text
• Passing non-string content to HTMLResponse
• Using FileResponse for text content

3. Given the code below, what will be the response content type sent to the client?

from fastapi import FastAPI
from fastapi.responses import HTMLResponse

app = FastAPI()

@app.get("/", response_class=HTMLResponse)
async def read_root():
    return "
Welcome
"

medium

A. text/html

B. application/json

C. text/plain

D. application/octet-stream

Solution

1. Step 1: Identify the response class used

   The route uses response_class=HTMLResponse, which sets the content type to HTML.

2. Step 2: Understand the content type sent

   HTMLResponse sends content with the header Content-Type: text/html.

3. Final Answer:

   text/html -> Option A

4. Quick Check:

   HTMLResponse = text/html content type [OK]

Hint: HTMLResponse sets content type to text/html [OK]

Common Mistakes:

• Assuming JSON is default content type
• Confusing plain text with HTML content type
• Ignoring the response_class parameter

4. What is wrong with this FastAPI endpoint using a custom response class?

from fastapi import FastAPI
from fastapi.responses import JSONResponse

app = FastAPI()

@app.get("/data")
async def get_data():
    return JSONResponse(content=[1, 2, 3], status_code="200")

medium

A. Missing return type annotation

B. content must be a dictionary, not a list

C. JSONResponse cannot be used in async functions

D. status_code should be an integer, not a string

Solution

1. Step 1: Check the status_code argument type

   Status codes must be integers, but here it is passed as a string "200".

2. Step 2: Understand the impact of wrong type

   Passing a string causes a runtime error or unexpected behavior in FastAPI.

3. Final Answer:

   status_code should be an integer, not a string -> Option D

4. Quick Check:

   Status code must be int, not str [OK]

Hint: Use integer for status_code, not string [OK]

Common Mistakes:

• Passing status_code as string
• Thinking content must be dict only
• Believing JSONResponse can't be async

5. You want to create a FastAPI endpoint that returns a CSV file for download using a custom response class. Which approach correctly sets the response to send a CSV file named "report.csv" with content "name,age\nAlice,30"?

hard

A. Use JSONResponse with content as CSV string and set media_type to 'text/csv'

B. Use StreamingResponse with content as bytes and set headers for CSV download

C. Use PlainTextResponse with content as CSV string and no headers

D. Use HTMLResponse with CSV content inside <pre> tags

Solution

1. Step 1: Choose the correct response class for file download

   StreamingResponse is suitable for sending files or streams with custom headers.

2. Step 2: Set content and headers properly

   Content should be bytes, and headers must include Content-Disposition to prompt file download with the filename.

3. Final Answer:

   Use StreamingResponse with content as bytes and set headers for CSV download -> Option B

4. Quick Check:

   StreamingResponse + headers = file download [OK]

Hint: Use StreamingResponse with headers for file downloads [OK]

Common Mistakes:

• Using JSONResponse for CSV files
• Not setting Content-Disposition header
• Using HTMLResponse for file content