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

在本文中，我们将介绍如何使用FastAPI和Pydantic对文件上传进行参数验证。FastAPI是一个高性能的现代Web框架，而Pydantic是一个数据验证和解析库，可以轻松处理从请求中接收到的数据。

FastAPI简介

FastAPI是一个基于Python类型提示（type hints）的现代Web框架，它具有超高的性能。它支持异步请求处理，使用请求参数作为功能参数，并提供自动化的API文档生成。FastAPI在Web开发中越来越受欢迎，因为它在极短的时间内可以构建高性能的API。

Pydantic简介

Pydantic是一个数据验证和解析库，它强调使用Python类型提示来定义数据模型，并且可以自动处理数据验证和转换。Pydantic能够很好地与FastAPI一起工作，使得在FastAPI中进行数据验证变得简单而直观。

文件上传的参数验证

在FastAPI中，可以使用Pydantic模型来定义期望传入的数据结构，并使用类型提示来指定数据类型。对于文件上传，我们可以使用UploadFile类型来接收和验证文件对象。

下面是一个示例，演示如何在FastAPI中使用Pydantic进行参数验证和文件上传：

from fastapi import FastAPI, UploadFile
from pydantic import BaseModel

app = FastAPI()

class FileData(BaseModel):
    file: UploadFile

@app.post("/upload_file/")
async def upload_file(file_data: FileData):
    contents = await file_data.file.read()
    return {"filename": file_data.file.filename, "contents": contents}

在这个示例中，我们定义了一个FileData模型，它有一个file字段，字段的类型是UploadFile。在upload_file路由函数中，我们通过将file_data参数标记为FileData类型，FastAPI将自动验证传入的文件对象，确保它符合我们定义的模型。

当我们向/upload_file/端点发出POST请求时，FastAPI会接收并验证我们传递的文件。我们可以通过访问file_data.file来访问上传的文件对象，然后可以执行任意的操作，比如读取文件内容、保存文件等。

额外的参数验证

除了文件上传外，我们还可以使用Pydantic模型对其他参数进行验证。我们可以在模型中定义其他字段，并为它们提供验证逻辑。比如，我们可以验证传递的文件大小不超过一定的限制，或者验证文件类型是否符合要求。

下面是一个示例，演示如何使用Pydantic对文件大小进行验证：

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

app = FastAPI()

class FileData(BaseModel):
    file: UploadFile

    @validator("file")
    def validate_file_size(cls, file):
        if file.filename.endswith(".jpg") and file.size > (1024 * 1024):
            raise ValueError("Invalid file size or type")
        return file

@app.post("/upload_file/")
async def upload_file(file_data: FileData):
    contents = await file_data.file.read()
    return {"filename": file_data.file.filename, "contents": contents}

在这个示例中，我们在FileData模型中定义了一个validate_file_size方法，用于验证文件大小和类型。如果我们传递的文件的类型是jpg且文件大小超过1MB，将会引发一个ValueError。

当我们使用这个模型进行参数验证时，如果传递的文件不符合验证规则，FastAPI会自动返回相应的错误响应。