如何在FastAPI POST请求中同时添加文件和JSON正文？

问题描述

具体地说，我希望下面的示例能够工作：

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


app = FastAPI()


class DataConfiguration(BaseModel):
    textColumnNames: List[str]
    idColumn: str


@app.post("/data")
async def data(dataConfiguration: DataConfiguration,
               csvFile: UploadFile = File(...)):
    pass
    # read requested id and text columns from csvFile

如果这不是POST请求的正确方式，请告诉我如何从FastAPI中上载的CSV文件中选择所需的列。

---

解决方案

不能将表单数据与JSON混用。

每个FastAPIdocumentation：

警告： 您可以在路径操作中声明多个File和Form参数，但是您不能同时声明期望作为JSON接收的Body字段，因为请求将使用multipart/form-data而不是application/json对正文进行编码。 这不是FastAPI的限制，它是HTTP协议的一部分。

但是，您可以使用Form(...)作为临时解决办法，将额外字符串附加为form-data：

from typing import List
from fastapi import FastAPI, UploadFile, File, Form


app = FastAPI()


@app.post("/data")
async def data(textColumnNames: List[str] = Form(...),
               idColumn: str = Form(...),
               csvFile: UploadFile = File(...)):
    pass