Custom response classes in FastAPI - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is a custom response class in FastAPI?

A custom response class in FastAPI is a way to define how the server sends data back to the client, allowing you to control the response format, headers, and content type beyond the default JSON response.

intermediate

How do you create a simple custom response class in FastAPI?

You create a custom response class by subclassing FastAPI's Response class and overriding methods like render() to define how the response content is generated.

beginner

Why would you use a custom response class instead of the default JSONResponse?

You use a custom response class to send data in formats other than JSON, like plain text, HTML, or custom media types, or to add special headers or control caching behavior.

beginner

Which FastAPI class is commonly extended to create a custom response?

The Response class from fastapi.responses is commonly extended to create custom response classes.

intermediate

What method must you override in a custom FastAPI response class to define the response body?

You must override the render() method to define how the response body is created from the data.

What is the default response class used by FastAPI for returning data?

A JSONResponse

B HTMLResponse

C PlainTextResponse

D StreamingResponse

FastAPI uses JSONResponse by default to send JSON data back to clients.

Which method do you override to customize the response content in a FastAPI custom response class?

A send()

B build()

C format()

D render()

The render() method is overridden to define how the response content is created.

If you want to send HTML content as a response, which FastAPI response class can you use?

A JSONResponse

B HTMLResponse

C FileResponse

D RedirectResponse

HTMLResponse is designed to send HTML content with the correct content type.

What is a common reason to create a custom response class in FastAPI?

A To customize response headers or content type

B To change the server port

C To modify request parameters

D To change database connections

Custom response classes let you control headers, content type, and how data is sent back.

Which FastAPI module contains the Response base class?

A fastapi.requests

B fastapi.middleware

C fastapi.responses

D fastapi.routing

The Response base class is in fastapi.responses.

Explain how to create and use a custom response class in FastAPI.

Think about how you control what the client receives and how you tell FastAPI about it.

Describe why and when you might want to use a custom response class instead of the default JSON response.

Consider different types of data your app might send back.

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