Custom response classes in FastAPI

Introduction

Custom response classes let you control how your FastAPI app sends data back to users. This helps you change the format, headers, or style of the response easily.

When you want to send plain text instead of JSON.

When you need to return HTML pages from your API.

When you want to send files like images or PDFs.

When you want to customize HTTP headers in the response.

When you want to change the response status code or media type.

Syntax

FastAPI

from fastapi import FastAPI

app = FastAPI()

@app.get("/path", response_class=ResponseClassName)
def function_name():
    return ResponseClassName(content, media_type="type")

Replace ResponseClassName with the FastAPI response class you want, like PlainTextResponse or HTMLResponse.

The content is the data you want to send back, and media_type tells the browser how to handle it.

Examples

This example sends plain text instead of JSON.

FastAPI

from fastapi import FastAPI
from fastapi.responses import PlainTextResponse

app = FastAPI()

@app.get("/text", response_class=PlainTextResponse)
def get_text():
    return "Hello, this is plain text!"

This example returns HTML content that browsers can render.

FastAPI

from fastapi import FastAPI
from fastapi.responses import HTMLResponse

app = FastAPI()

@app.get("/html", response_class=HTMLResponse)
def get_html():
    return "<h1>Welcome to FastAPI!</h1>"

This example shows how to customize JSON response with a different status code.

FastAPI

from fastapi import FastAPI
from fastapi.responses import JSONResponse

app = FastAPI()

@app.get("/custom-json", response_class=JSONResponse)
def get_custom_json():
    return JSONResponse(content={"message": "Custom JSON response"}, status_code=202)

Sample Program

This FastAPI app has two routes. One returns a full HTML page, and the other returns plain text. Both use custom response classes to tell FastAPI how to send the data.

FastAPI

from fastapi import FastAPI
from fastapi.responses import PlainTextResponse, HTMLResponse

app = FastAPI()

@app.get("/welcome", response_class=HTMLResponse)
def welcome():
    html_content = """
    <html>
        <head>
            <title>Welcome Page</title>
        </head>
        <body>
            <h1>Hello, visitor!</h1>
            <p>This is a custom HTML response.</p>
        </body>
    </html>
    """
    return html_content

@app.get("/message", response_class=PlainTextResponse)
def message():
    return "This is a plain text message."

Important Notes

Using custom response classes helps browsers and clients understand the data format better.

You can create your own response classes by extending FastAPI's Response class if needed.

Always set the correct media_type to avoid confusion in clients.

Summary

Custom response classes control how FastAPI sends data back.

Use them to send text, HTML, files, or custom JSON easily.

They help make your API responses clear and correct for users and browsers.

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