FastAPI 使用 Pydantic 进行文件上传的参数验证

在本文中，我们将介绍如何使用 FastAPI 和 Pydantic 进行文件上传的参数验证。FastAPI 是一个快速（高性能）的 web 框架，适用于构建 API，而 Pydantic 是一个用于数据验证和解析的库。

阅读更多：FastAPI 教程

FastAPI 简介

FastAPI 是一个现代、高性能的 web 框架，基于 Python 3.7+ 支持异步请求，在许多方面比传统框架（如 Flask 和 Django）更快。它具有自动请求和响应验证、自动文档生成、自动路由生成等强大功能。

Pydantic 简介

Pydantic 是一个用于数据验证和解析的库，它基于 Python 的类型注解和运行时的验证机制。通过定义基于 Pydantic 模型的数据结构和字段约束，我们可以轻松地对请求参数进行验证和解析。

文件上传参数验证

在 FastAPI 中，我们可以使用 Pydantic 模型对文件上传的参数进行验证。以下是一个示例：

from fastapi import FastAPI, UploadFile, File
from pydantic import BaseModel

app = FastAPI()

class FileMetadata(BaseModel):
    name: str
    content_type: str

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

在上述示例中，我们定义了一个 FileMetadata 类，用于验证上传文件的元数据。file 和 metadata 参数都是使用 File 类型进行注释的。

• file: UploadFile = File(...)：该参数用于接收上传的文件。UploadFile 是 FastAPI 提供的一个类，用于处理文件上传。
• metadata: FileMetadata = File(...)：该参数用于接收文件的元数据，例如文件名和内容类型。

我们可以使用 ... 表示这些参数是必需的，如果没有提供这些参数，FastAPI 将返回 422 Unprocessable Entity 错误。

示例说明

现在我们来测试一下我们的文件上传接口。

首先，我们需要安装 FastAPI 和 Uvicorn：

$ pip install fastapi uvicorn

然后，我们创建一个 main.py 文件，并复制上述示例代码。

接下来，使用以下命令运行 FastAPI 服务器：

$ uvicorn main:app --reload

我们可以使用 cURL 或其他工具来测试上传文件的接口：

$ curl -X POST -F "file=@example.txt" -F "metadata={\"name\":\"example.txt\",\"content_type\":\"text/plain\"}" http://localhost:8000/upload_file/

上述命令将上传一个名为 example.txt 的文件，并提供相应的元数据。

服务器将返回以下响应：

{
    "filename": "example.txt",
    "metadata": {
        "name": "example.txt",
        "content_type": "text/plain"
    }
}

总结

通过使用 FastAPI 和 Pydantic，我们可以轻松地对文件上传的参数进行验证。FastAPI 提供了强大的类型检查和验证功能，而 Pydantic 则提供了灵活和易于使用的数据验证机制。

在开发 API 时，确保参数的正确性非常重要。利用 FastAPI 和 Pydantic 的结合，我们可以确保上传文件参数的正确性，并获得更好的开发体验。