Multiple response types in FastAPI - Performance & Optimization

Performance: Multiple response types

MEDIUM IMPACT

This affects server response time and client rendering speed by controlling how data is serialized and sent over the network.

Returning different response formats based on client needs

FastAPI

from fastapi import FastAPI
from fastapi.responses import JSONResponse
from fastapi.templating import Jinja2Templates
from fastapi import Request

app = FastAPI()
templates = Jinja2Templates(directory="templates")

@app.get("/item")
async def get_item(request: Request, response_type: str = "json"):
    data = {"item": "value"}
    if response_type == "html":
        return templates.TemplateResponse("item.html", {"request": request, "data": data})
    return JSONResponse(content=data)

Using template rendering for HTML and JSONResponse for JSON ensures efficient serialization and smaller, optimized payloads.

📈 Performance GainReduces CPU overhead and payload size, improving LCP by ~50ms and lowering server load

Returning different response formats based on client needs

FastAPI

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

app = FastAPI()

@app.get("/item")
async def get_item(response_type: str):
    data = {"item": "value"}
    if response_type == "html":
        return HTMLResponse(content=f"<html><body>{data['item']}</body></html>")
    else:
        return JSONResponse(content=data)

Manually constructing HTML strings and switching response types in the endpoint can cause inconsistent serialization and larger payloads.

📉 Performance CostAdds extra CPU for string concatenation and larger HTML payload increases LCP by ~50ms on slow networks

Performance Comparison

Pattern	DOM Operations	Reflows	Paint Cost	Verdict
Manual HTML string + JSON switch	Minimal	Minimal	Higher due to larger payload	[X] Bad
Template rendering + JSONResponse	Minimal	Minimal	Lower due to optimized payload	[OK] Good

Rendering Pipeline

The server serializes data into the chosen response type, sends it over the network, and the browser parses and renders it accordingly.

→Server Serialization

→Network Transfer

→Browser Parsing

→Rendering

⚠️ BottleneckServer Serialization and Network Transfer

Core Web Vital Affected

LCP

This affects server response time and client rendering speed by controlling how data is serialized and sent over the network.

Optimization Tips

1Use FastAPI's built-in JSONResponse and template rendering for different response types.

2Avoid manual string concatenation for HTML to reduce CPU and payload size.

3Choose response types that minimize payload size to improve LCP.

Performance Quiz - 3 Questions

Which response type choice most improves Largest Contentful Paint (LCP) in FastAPI?

A Manually building HTML strings for all responses

B Using JSONResponse for JSON and template rendering for HTML

C Returning plain text for all responses

D Sending large HTML payloads regardless of client needs

DevTools: Network

How to check: Open DevTools, go to Network tab, reload the endpoint, and inspect the response size and content type.

What to look for: Look for smaller payload size and correct content-type headers indicating efficient response format.

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