Why Multiple response types in FastAPI? - Purpose & Use Cases

The Big Idea

Discover how to make your API smart enough to speak the right language every time!

The Scenario

Imagine building an API that sometimes returns JSON data, sometimes a file download, and other times an HTML page--all depending on the user's request.

The Problem

Manually checking request headers and crafting different responses for each type leads to messy, repetitive code that is hard to maintain and easy to break.

The Solution

FastAPI lets you declare multiple response types clearly and handles the logic to return the right format automatically, keeping your code clean and reliable.

Before vs After

✗ Before

if request.headers['Accept'] == 'application/json': return JSONResponse(data)
elif request.headers['Accept'] == 'text/html': return HTMLResponse(html)
else: return FileResponse(file)

✓ After

@app.get('/', response_class=Union[JSONResponse, HTMLResponse, FileResponse])
async def root():
    # FastAPI picks the right response type automatically
    ...

What It Enables

You can easily build flexible APIs that serve different clients and content types without messy code.

Real Life Example

A photo-sharing app API that returns JSON metadata, serves image files, or shows an HTML gallery page depending on the request.

Key Takeaways

Manual response handling is complex and error-prone.

FastAPI's multiple response types simplify returning different formats.

This leads to cleaner, more maintainable API code.

Practice

1. What is the main purpose of using multiple response types in a FastAPI route?

easy

A. To speed up the API response time by caching

B. To allow the API to send different response formats based on conditions

C. To restrict the API to only one response format

D. To automatically generate database schemas

Solution

1. Step 1: Understand response types in FastAPI

   Multiple response types let an API send different formats like JSON or HTML depending on the request or logic.

2. Step 2: Identify the purpose

   This flexibility helps clients get the response format they expect or need.

3. Final Answer:

   To allow the API to send different response formats based on conditions -> Option B

4. Quick Check:

   Multiple response types = different formats [OK]

Hint: Multiple response types mean flexible output formats [OK]

Common Mistakes:

• Thinking it speeds up response time
• Believing it restricts to one format
• Confusing with database schema generation

2. Which of the following is the correct way to declare multiple response types in a FastAPI route decorator?

easy

A. @app.get('/items', responses={200: {'content': {'application/json': {}}}})

B. @app.get('/items', response_formats=['json', 'html'])

C. @app.get('/items', response_type=['json', 'html'])

D. @app.get('/items', responses={200: {'content': {'application/json': {}, 'text/html': {}}}})

Solution

1. Step 1: Review FastAPI response declaration syntax

   FastAPI uses the 'responses' parameter with status codes and content types as keys.

2. Step 2: Identify correct syntax for multiple types

   @app.get('/items', responses={200: {'content': {'application/json': {}, 'text/html': {}}}}) correctly shows multiple content types under the 200 status code.

3. Final Answer:

   @app.get('/items', responses={200: {'content': {'application/json': {}, 'text/html': {}}}}) -> Option D

4. Quick Check:

   responses param with content dict = @app.get('/items', responses={200: {'content': {'application/json': {}, 'text/html': {}}}}) [OK]

Hint: Use 'responses' with content dict for multiple types [OK]

Common Mistakes:

• Using non-existent parameters like response_type
• Declaring only one content type when multiple needed
• Incorrect dictionary structure in responses

3. Given this FastAPI route, what will be the response content type if return HTMLResponse(content='Hello') is used?

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

app = FastAPI()

@app.get('/greet', responses={200: {'content': {'application/json': {}, 'text/html': {}}}})
async def greet(html: bool = False):
    if html:
        return HTMLResponse(content='Hello')
    return JSONResponse(content={'message': 'Hello'})

medium

A. text/html

B. application/json

C. application/xml

D. text/plain

Solution

1. Step 1: Check the return type when html=True

   The function returns HTMLResponse with content 'Hello' when html is True.

2. Step 2: Identify the content type of HTMLResponse

   HTMLResponse sets the content type to 'text/html'.

3. Final Answer:

   text/html -> Option A

4. Quick Check:

   HTMLResponse = text/html [OK]

Hint: HTMLResponse means content type text/html [OK]

Common Mistakes:

• Assuming JSONResponse is always returned
• Confusing content type with return value
• Ignoring the condition that triggers HTMLResponse

4. Identify the error in this FastAPI route that tries to return multiple response types:

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

app = FastAPI()

@app.get('/data', responses={200: {'content': {'application/json': {}, 'text/plain': {}}}})
async def data(response_type: str):
    if response_type == 'json':
        return JSONResponse(content={'key': 'value'})
    else:
        return 'Just plain text'

medium

A. responses dictionary is incorrectly formatted

B. Missing import for PlainTextResponse

C. Returning a plain string instead of a Response object for plain text

D. Function should not be async

Solution

1. Step 1: Check return types in the function

   When response_type is not 'json', the function returns a plain string instead of a Response object.

2. Step 2: Understand FastAPI response requirements

   FastAPI expects a Response object like PlainTextResponse for non-JSON responses to set headers correctly.

3. Final Answer:

   Returning a plain string instead of a Response object for plain text -> Option C

4. Quick Check:

   Plain string return needs PlainTextResponse [OK]

Hint: Return Response objects, not raw strings for non-JSON [OK]

Common Mistakes:

• Returning raw strings instead of Response objects
• Ignoring response content type headers
• Assuming async is not needed

5. You want a FastAPI route to return JSON by default but HTML if a query parameter ?format=html is given. Which approach correctly implements this with multiple response types?

from fastapi import FastAPI, Request
from fastapi.responses import JSONResponse, HTMLResponse

app = FastAPI()

@app.get('/info', responses={200: {'content': {'application/json': {}, 'text/html': {}}}})
async def info(request: Request):
    format = request.query_params.get('format')
    if format == 'html':
        # What to return here?
    else:
        return JSONResponse(content={'info': 'data'})

hard

A. return HTMLResponse(content='Info')

B. return {'info': 'Info'}

C. return JSONResponse(content={'info': 'Info'})

D. return Response(content='Info', media_type='application/json')

Solution

1. Step 1: Check the condition for HTML format

   If the query parameter 'format' equals 'html', the route should return an HTML response.

2. Step 2: Use the correct response class for HTML

   HTMLResponse sets the content type to 'text/html' and sends HTML content properly.

3. Final Answer:

   return HTMLResponse(content='<h1>Info</h1>') -> Option A

4. Quick Check:

   HTMLResponse for HTML output = return HTMLResponse(content='<h1>Info</h1>') [OK]

Hint: Use HTMLResponse to send HTML content explicitly [OK]

Common Mistakes:

• Returning dict with HTML string instead of HTMLResponse
• Using JSONResponse with HTML content type
• Setting wrong media_type in Response