File upload (single file) in FastAPI

Introduction

Uploading files lets users send documents or images to your app. It helps your app receive data like photos or reports.

When users need to upload a profile picture.

When a form requires a document like a resume or certificate.

When users want to send a single image for processing.

When collecting one file for storage or review.

When your app needs to accept one file at a time from users.

Syntax

FastAPI

from fastapi import FastAPI, File, UploadFile

app = FastAPI()

@app.post("/uploadfile/")
async def upload_file(file: UploadFile = File(...)):
    contents = await file.read()
    return {"filename": file.filename, "content_type": file.content_type}

UploadFile is used to handle the uploaded file efficiently.

File(...) marks the parameter as required for upload.

Examples

This example returns only the uploaded file's name.

FastAPI

from fastapi import FastAPI, File, UploadFile

app = FastAPI()

@app.post("/uploadfile/")
async def upload_file(file: UploadFile = File(...)):
    return {"filename": file.filename}

This example reads the file content and returns its size in bytes.

FastAPI

from fastapi import FastAPI, File, UploadFile

app = FastAPI()

@app.post("/uploadfile/")
async def upload_file(file: UploadFile = File(...)):
    contents = await file.read()
    size = len(contents)
    return {"filename": file.filename, "size_bytes": size}

Sample Program

This complete FastAPI app accepts one uploaded file. It reads the file content to get its size and returns the file name, type, and size as JSON.

FastAPI

from fastapi import FastAPI, File, UploadFile

app = FastAPI()

@app.post("/uploadfile/")
async def upload_file(file: UploadFile = File(...)):
    contents = await file.read()
    return {
        "filename": file.filename,
        "content_type": file.content_type,
        "size_bytes": len(contents)
    }

Important Notes

Use UploadFile for better performance with large files instead of reading all bytes at once.

Always check file.content_type to validate file types for security.

Remember to handle exceptions for missing or invalid files.

Summary

Use UploadFile and File(...) to accept single file uploads in FastAPI.

Read file content asynchronously with await file.read() to get file data.

Return useful info like filename, content type, and size to confirm upload success.

Practice

1. In FastAPI, which parameter type is used to accept a single uploaded file in an endpoint?

easy

A. List[UploadFile]

B. str

C. UploadFile

D. int

Solution

1. Step 1: Understand FastAPI file upload types

   FastAPI uses UploadFile to handle file uploads efficiently.

2. Step 2: Identify single file upload parameter

   For a single file, the parameter type is UploadFile, not a list or primitive type.

3. Final Answer:

   <code>UploadFile</code> -> Option C

4. Quick Check:

   Single file upload uses UploadFile [OK]

Hint: Use UploadFile for single file upload in FastAPI [OK]

Common Mistakes:

• Using str or int instead of UploadFile
• Using List[UploadFile] for single file
• Not importing UploadFile from fastapi

2. Which of the following is the correct way to declare a FastAPI endpoint parameter to accept a single file upload?

easy

A. file: str = File(...)

B. file: bytes = File(...)

C. file: UploadFile

D. file: UploadFile = File(...)

Solution

1. Step 1: Check parameter declaration for file upload

   FastAPI requires File(...) to mark the parameter as a file upload.

2. Step 2: Match type with File marker

   The type must be UploadFile combined with File(...) for single file upload.

3. Final Answer:

   file: UploadFile = File(...) -> Option D

4. Quick Check:

   UploadFile with File(...) is correct syntax [OK]

Hint: Use UploadFile = File(...) to accept single file [OK]

Common Mistakes:

• Omitting File(...) marker
• Using str or bytes instead of UploadFile
• Not assigning default File(...)

3. What will be the output of this FastAPI endpoint when a file named 'test.txt' with content 'hello' is uploaded?

from fastapi import FastAPI, UploadFile, File
app = FastAPI()

@app.post('/upload')
async def upload(file: UploadFile = File(...)):
    content = await file.read()
    return {'filename': file.filename, 'content_type': file.content_type, 'size': len(content)}

medium

A. {'filename': 'test.txt', 'content_type': 'text/plain', 'size': 5}

B. {'filename': 'test.txt', 'content_type': 'application/octet-stream', 'size': 0}

C. {'filename': '', 'content_type': '', 'size': 5}

D. RuntimeError due to missing await

Solution

1. Step 1: Read file content asynchronously

   The code uses await file.read() to get the file bytes, so content length is 5 for 'hello'.

2. Step 2: Return file info correctly

   Filename is 'test.txt', content type is 'text/plain' (default for .txt), size is length of content (5).

3. Final Answer:

   {'filename': 'test.txt', 'content_type': 'text/plain', 'size': 5} -> Option A

4. Quick Check:

   File info returned matches uploaded file [OK]

Hint: Await file.read() to get content size correctly [OK]

Common Mistakes:

• Not awaiting file.read() causing empty content
• Assuming wrong content_type
• Returning filename as empty string

4. Identify the error in this FastAPI endpoint code for single file upload:

from fastapi import FastAPI, UploadFile
app = FastAPI()

@app.post('/upload')
def upload(file: UploadFile = File(...)):
    content = file.read()
    return {'filename': file.filename, 'size': len(content)}

medium

A. Missing import of File from fastapi

B. All of the above

C. file.read() should be awaited in async function

D. Endpoint function must be async to await file.read()

Solution

1. Step 1: Check imports and function signature

   The code misses importing File and the function is not async but calls file.read() which is async.

2. Step 2: Identify async usage and await

   To read file content, function must be async and use await file.read().

3. Final Answer:

   All of the above -> Option B

4. Quick Check:

   Missing import, async, and await cause errors [OK]

Hint: Import File, make function async, await file.read() [OK]

Common Mistakes:

• Forgetting to import File
• Using sync function with async file.read()
• Not awaiting file.read()

5. You want to create a FastAPI endpoint that accepts a single file upload and returns the file's name, content type, and first 10 bytes as a UTF-8 string. Which code snippet correctly implements this?

hard

A. from fastapi import FastAPI, UploadFile, File
app = FastAPI()

@app.post('/upload')
async def upload(file: UploadFile = File(...)):
content = await file.read()
preview = content[:10].decode('utf-8')
return {'filename': file.filename, 'content_type': file.content_type, 'preview': preview}

B. from fastapi import FastAPI, UploadFile
app = FastAPI()

@app.post('/upload')
def upload(file: UploadFile):
content = file.read()
preview = content[:10].decode('utf-8')
return {'filename': file.filename, 'content_type': file.content_type, 'preview': preview}

C. from fastapi import FastAPI, UploadFile, File
app = FastAPI()

@app.post('/upload')
async def upload(file: bytes = File(...)):
preview = file[:10].decode('utf-8')
return {'filename': 'unknown', 'content_type': 'unknown', 'preview': preview}

D. from fastapi import FastAPI, UploadFile, File
app = FastAPI()

@app.post('/upload')
async def upload(file: UploadFile = File(...)):
content = await file.read()
preview = content.decode('utf-8')[:10]
return {'filename': file.filename, 'content_type': file.content_type, 'preview': preview}

Solution

1. Step 1: Use async function with UploadFile and File(...)

   Correct signature is async def with parameter file: UploadFile = File(...).

2. Step 2: Read file content and decode first 10 bytes

   Read content with await file.read(), then slice first 10 bytes and decode to UTF-8 string.

3. Step 3: Return filename, content_type, and preview string

   Return dictionary with correct file info and preview snippet.

4. Final Answer:

   Option A code snippet -> Option A

5. Quick Check:

   Async read, slice, decode first 10 bytes [OK]

Hint: Await read, slice first 10 bytes, decode UTF-8 [OK]

Common Mistakes:

• Using sync function without await
• Decoding entire content before slicing
• Using bytes type instead of UploadFile