File responses in FastAPI - Mini Project: Build & Apply

Serving a File with FastAPI

📖 Scenario: You are building a simple web service that sends a file to users when they visit a specific URL. This is useful for sharing documents, images, or any downloadable content.

🎯 Goal: Create a FastAPI app that serves a file called example.txt located in the project folder when a user visits the /download URL.

📋 What You'll Learn

Create a FastAPI app instance named app

Create a file named example.txt with the exact content: Hello, FastAPI file response!

Add a route /download that returns the file example.txt using FastAPI's FileResponse

Ensure the file is served with the correct media type and filename

💡 Why This Matters

🌍 Real World

Web services often need to send files like reports, images, or documents to users. FastAPI's FileResponse makes this easy and efficient.

💼 Career

Backend developers use FastAPI to build APIs that serve files securely and quickly. Knowing how to serve files is a common task in web development jobs.

1

Create the file example.txt

Create a file named example.txt in your project folder with the exact content: Hello, FastAPI file response!

FastAPI

# Create the file example.txt with the specified content

Hint

Use a text editor or Python code to create example.txt with the exact text inside.

2

Create a FastAPI app instance

Write code to import FastAPI from fastapi and create an app instance named app.

FastAPI

from fastapi import FastAPI

# Create the FastAPI app instance named app
# Your code here

Hint

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

3

Import FileResponse and add the /download route

Import FileResponse from fastapi.responses. Then add a route /download using @app.get("/download") that returns FileResponse("example.txt").

FastAPI

from fastapi.responses import FileResponse

# Add the /download route below
# Your code here

Hint

Use FileResponse to send the file with correct media type text/plain and filename example.txt.

4

Complete the FastAPI file response setup

Ensure the route function download_file is async and returns FileResponse with media_type="text/plain" and filename="example.txt".

FastAPI

# Verify the route function is async and returns FileResponse with correct parameters
# Your code here

Hint

The function must be async and return the file response with the exact parameters.

Practice

1. What is the main purpose of FileResponse in FastAPI?

easy

A. To send files from the server to the client

B. To upload files from the client to the server

C. To delete files on the server

D. To read file contents as text

Solution

1. Step 1: Understand the role of FileResponse

   FileResponse is designed to send files from the server to the client in FastAPI.

2. Step 2: Differentiate from other file operations

   Uploading or deleting files are handled differently; FileResponse specifically sends files.

3. Final Answer:

   To send files from the server to the client -> Option A

4. Quick Check:

   FileResponse sends files [OK]

Hint: FileResponse is for sending files to users [OK]

Common Mistakes:

• Confusing FileResponse with file upload handling
• Thinking FileResponse reads file content as text
• Assuming FileResponse deletes files

2. Which of the following is the correct way to import FileResponse in FastAPI?

easy

A. from fastapi.responses import file_response

B. from fastapi import FileResponse

C. import FileResponse from fastapi.responses

D. from fastapi.responses import FileResponse

Solution

1. Step 1: Recall correct import syntax

   FastAPI's FileResponse is imported from fastapi.responses using Python's standard import syntax.

2. Step 2: Check each option's correctness

   from fastapi.responses import FileResponse uses correct syntax and casing. from fastapi import FileResponse misses the submodule. import FileResponse from fastapi.responses uses wrong syntax. from fastapi.responses import file_response uses wrong casing.

3. Final Answer:

   from fastapi.responses import FileResponse -> Option D

4. Quick Check:

   Correct import is from fastapi.responses [OK]

Hint: Import FileResponse from fastapi.responses [OK]

Common Mistakes:

• Using wrong import syntax like 'import X from Y'
• Importing directly from fastapi without .responses
• Wrong casing like file_response instead of FileResponse

3. What will the following FastAPI endpoint return?

from fastapi import FastAPI
from fastapi.responses import FileResponse

app = FastAPI()

@app.get('/download')
async def download_file():
    return FileResponse('example.pdf', media_type='application/pdf', filename='report.pdf')

medium

A. Returns JSON with file path 'example.pdf'

B. Sends the file 'example.pdf' with download name 'report.pdf' and PDF media type

C. Raises an error because filename cannot be set

D. Sends 'report.pdf' file ignoring 'example.pdf'

Solution

1. Step 1: Analyze FileResponse parameters

   The first argument is the file path to send ('example.pdf'). The media_type sets the content type to PDF. The filename sets the suggested download name.

2. Step 2: Understand the endpoint behavior

   When called, the endpoint sends the file 'example.pdf' with content type 'application/pdf' and suggests the name 'report.pdf' for download.

3. Final Answer:

   Sends the file 'example.pdf' with download name 'report.pdf' and PDF media type -> Option B

4. Quick Check:

   FileResponse sends file with given path and filename [OK]

Hint: FileResponse(path, media_type, filename) sends file with custom name [OK]

Common Mistakes:

• Thinking filename argument changes the file read
• Expecting JSON response instead of file
• Assuming filename cannot be set

4. Identify the error in this FastAPI endpoint that tries to send a file:

from fastapi import FastAPI
from fastapi.responses import FileResponse

app = FastAPI()

@app.get('/file')
async def get_file():
    return FileResponse(filepath='data.txt', media_type='text/plain')

medium

A. FileResponse does not accept a 'filepath' keyword argument

B. The media_type 'text/plain' is invalid

C. FileResponse requires a filename argument

D. The endpoint must be synchronous, not async

Solution

1. Step 1: Check FileResponse constructor parameters

   FileResponse expects the file path as the first positional argument, not as a 'filepath' keyword argument.

2. Step 2: Identify the error cause

   Passing 'filepath=' causes a TypeError because FileResponse does not have a 'filepath' parameter.

3. Final Answer:

   FileResponse does not accept a 'filepath' keyword argument -> Option A

4. Quick Check:

   FileResponse needs file path as first argument, no 'filepath=' [OK]

Hint: FileResponse takes file path as first argument, no 'filepath=' keyword [OK]

Common Mistakes:

• Using 'filepath=' keyword instead of positional argument
• Thinking filename is mandatory
• Believing async is not allowed for endpoints

5. You want to create a FastAPI endpoint that sends a file only if it exists, otherwise returns a 404 error. Which code snippet correctly implements this behavior?

hard

A. from fastapi import FastAPI
from fastapi.responses import FileResponse

app = FastAPI()

@app.get('/download')
async def download():
return FileResponse('file.txt')

B. from fastapi import FastAPI
from fastapi.responses import FileResponse

app = FastAPI()

@app.get('/download')
async def download():
try:
return FileResponse('file.txt')
except FileNotFoundError:
return {'error': 'File missing'}

C. from fastapi import FastAPI, HTTPException
from fastapi.responses import FileResponse
import os

app = FastAPI()

@app.get('/download')
async def download():
if os.path.exists('file.txt'):
return FileResponse('file.txt')
else:
raise HTTPException(status_code=404, detail='File not found')

D. from fastapi import FastAPI
from fastapi.responses import FileResponse

app = FastAPI()

@app.get('/download')
async def download():
if 'file.txt' in os.listdir('.'):
return FileResponse('file.txt')
else:
return {'error': 'File not found'}

Solution

1. Step 1: Check file existence properly

   Using os.path.exists('file.txt') correctly checks if the file exists before sending.

2. Step 2: Return appropriate response on missing file

   Raising HTTPException with 404 status is the proper way to signal file not found in FastAPI.

3. Final Answer:

   Code snippet B correctly checks file existence and raises 404 if missing -> Option C

4. Quick Check:

   Check file with os.path.exists + raise HTTPException [OK]

Hint: Check file with os.path.exists, raise HTTPException 404 if missing [OK]

Common Mistakes:

• Not checking file existence before sending
• Returning JSON error instead of raising HTTPException
• Using try-except without proper exception handling