使用fastapi下载文件

基础概念

FastAPI 是一个用于构建 API 的现代、快速（高性能）的 web 框架，基于 Python 3.7+ 的类型提示。它使用异步编程模型，可以显著提高应用程序的性能。

相关优势

1. 高性能：FastAPI 使用 ASGI（异步服务器网关接口），能够处理大量并发请求。
2. 类型提示：利用 Python 的类型提示功能，FastAPI 可以自动生成交互式 API 文档。
3. 内置数据验证：通过 Pydantic 模型，FastAPI 可以自动验证输入数据。
4. 易于扩展：支持自定义异常处理、中间件、依赖注入等。

类型

FastAPI 主要用于构建 RESTful API，支持各种 HTTP 方法（GET、POST、PUT、DELETE 等）。

应用场景

FastAPI 适用于构建高性能的 web 服务，特别是在需要处理大量并发请求的场景中，如微服务、实时数据处理等。

下载文件的示例代码

以下是一个使用 FastAPI 下载文件的示例代码：

from fastapi import FastAPI, Response
import shutil
import os

app = FastAPI()

@app.get("/download/{filename}")
async def download_file(filename: str):
    file_path = f"./files/{filename}"
    
    if not os.path.exists(file_path):
        return Response(content="File not found", status_code=404)
    
    response = Response(
        content=shutil.copyfileobj(open(file_path, 'rb'), Response().body),
        media_type="application/octet-stream",
        headers={"Content-Disposition": f"attachment; filename={filename}"}
    )
    
    return response

解释

1. 路由定义：@app.get("/download/{filename}") 定义了一个 GET 请求的路由，路径中包含一个动态参数 filename。
2. 文件路径检查：if not os.path.exists(file_path): 检查文件是否存在，如果不存在则返回 404 错误。
3. 文件读取和响应：shutil.copyfileobj(open(file_path, 'rb'), Response().body) 读取文件内容并写入响应体，设置 media_type 为 application/octet-stream，表示这是一个二进制流，同时设置 Content-Disposition 头部，提示浏览器下载文件。

参考链接

• FastAPI 官方文档
• Pydantic 官方文档

常见问题及解决方法

1. 文件不存在：确保文件路径正确，并且文件确实存在于指定路径。
2. 权限问题：确保运行 FastAPI 应用的用户有权限读取文件。
3. 大文件下载：对于大文件，可以考虑使用流式传输，避免一次性加载整个文件到内存中。

通过以上步骤，你可以使用 FastAPI 实现文件下载功能，并处理常见的相关问题。