如何使用FastAPI和Python请求传递字符串和多个文件？

Question

我正在使用以下接受多个文件的FastAPIendpoint：

from fastapi import Request, FastAPI, File, UploadFile
from typing import List
import uvicorn

app = FastAPI()

@app.post("/multiplefiles")
async def _file_upload(keywords, files: List[UploadFile] = File(...)): #create_file
    return {"len_files": keywords}

我想先输入关键字参数，然后输入文件列表，但我找不到执行有效 post 请求的方法：

import requests

files = (("keywords", "key1"),
    [
    ('files', open('files\file1.pdf', 'rb')), 
    ('files', open('files\file2.pdf', 'rb'))
    ]
)

response = requests.post('http://127.0.0.1:3000/multiplefiles', files=files)
print(response.json())

如果我只上传文件作为元组工作列表，但我不知道如何传入关键字参数。

Answer 1

在endpoint中定义关键字参数的方式中，预计是查询参数。如果您希望它是单个字符串值，您可以使用str定义它，如下所示：

服务器端:

@app.post("/")
def upload(keywords: str, files: List[UploadFile] = File(...)):
    return {"keywords": keywords}

由于它应作为查询参数，因此应在 Python 请求中使用 params 参数，以便传递查询参数，如此处所述。例：

客户端：

url = 'http://127.0.0.1:8000/'
data = {'keywords': 'key1'}
r = requests.post(url, files=files, params=data)
print(r.json())

您也可以将其直接传递给URL：

url = 'http://127.0.0.1:8000?keywords=key1'

如果要发送关键字列表，则必须使用 List 类型（或 Python 3.9 中的 list ）声明关键字查询参数，并使用 Query 显式定义它，以便它可以接收值列表，或者换句话说，接收多个值 - 请参阅此处、此处和此处的相关答案（有关任意查询参数，请参阅此处和此处）。例：

服务器端:

from fastapi import Query

@app.post("/")
def upload(keywords: List[str] = Query(...), files: List[UploadFile] = File(...)):
    return {"keywords": keywords} 

客户端：

url = 'http://127.0.0.1:8000/'
data = {'keywords': ['key1', 'key2']}
r = requests.post(url, files=files, params=data)
print(r.json())

如果您想自己将关键字列表添加到URL的查询字符串中，则应该如下所示：

url = 'http://127.0.0.1:8000?keywords=key1&keywords=key2'

如果您想使用< code>Form参数来传递附加数据以及< code >文件，请看看这个答案。