FastAPI 文件参数：同时处理文件与表单数据的有效方法

FastAPI 文件参数：同时处理文件与表单数据的有效方法

在 Web 开发中，文件上传和表单数据的处理是常见的任务。FastAPI 提供了灵活且高效的方式来处理文件上传和表单字段的数据。通过使用 File 和 Form 参数，开发者可以轻松接收和处理文件内容以及其他表单数据。本文介绍了如何在 FastAPI 中同时声明文件字段和表单字段，支持多种类型的数据转换，包括字符串、整数、浮动数等。此外，我们还探讨了如何利用 UploadFile 提供更多的文件处理功能，如获取文件名和文件类型。借助 FastAPI，文件上传和表单数据的处理变得简单而高效，为开发人员提供了强大的工具。

以下示例中使用的 Python 版本为 Python 3.10.15，FastAPI 版本为 0.115.4。

一 导入文件和表单

FastAPI 支持同时使用 File 和 Form 来定义文件和表单字段，以便于处理上传文件和表单数据。

from fastapi import FastAPI, File, Form, UploadFile

app = FastAPI()

# 创建一个POST接口，用于上传文件和表单数据
@app.post("/files01/")
async def create_file(
  			# file字段，接收文件内容，类型为bytes
        file: bytes = File(), 
   			# fileb字段，接收上传的文件，类型为UploadFile
        fileb: UploadFile = File(), 
  			# token字段，接收表单字段，类型为字符串 
        token: str = Form()):
    return {
      	 # 返回上传文件的大小 
        "file_size": len(file),
      	 # 返回表单字段中的token值
        "token": token,
       	 # 返回上传文件的content_type  
        "fileb_content_type": fileb.content_type,
    }

运行代码文件 chapter21.py 来启动应用：

$ uvicorn chapter21:app --reload

在 SwaggerUI 中可以查看在线文档：http://127.0.0.1:8000/docs 。

注：使用文件上传或表单数据需预先安装 python-multipart，可以通过以下命令安装：

$ pip install python-multipart

二 同时声明 File 和 Form 参数

在 FastAPI 中，可以同时声明文件上传和表单字段。File 用于声明文件字段，Form 用于声明表单字段。这样可以同时处理文件数据和表单数据。

@app.post("/files01/")
async def create_file(
        file: bytes = File(), fileb: UploadFile = File(), token: str = Form()):
    return {
        "file_size": len(file),
        "token": token,
        "fileb_content_type": fileb.content_type,
    }

三 文件与表单字段的接收

对于文件上传，推荐使用 File 和 Form 搭配，以确保能够接收文件和表单字段数据。

• File：有两种方式可以声明文件字段，一种是 bytes 类型（用于接收文件内容），另一种是 UploadFile（用于接收文件对象）。UploadFile 提供了一些额外的属性（例如 filename 和 content_type），便于处理文件。
• Form：用于接收表单字段，它们的值会作为字符串类型传递，但 FastAPI 可以根据声明的类型自动进行转换，支持传递整数、浮动数、布尔值、日期等类型的数据。
• 在同一个路径操作中，可以声明多个 File 和 Form 参数，但不能同时声明接收 JSON 数据的 Body 字段。这是由于请求体的编码类型为 multipart/form-data，而不是 application/json，无法在同一个请求中同时传递 JSON 数据，这是 HTTP 协议的规定。

四 完整代码示例

from fastapi import FastAPI, File, Form, UploadFile

app = FastAPI()


@app.post("/files01/")
async def create_file(
        file: bytes = File(), fileb: UploadFile = File(), token: str = Form()):
    return {
        "file_size": len(file),
        "token": token,
        "fileb_content_type": fileb.content_type,
    }

五 源码地址

详情见：GitHub FastApiProj

六 参考

[1] FastAPI 文档