python - 使用 FastAPI 读取正文 JSON 列表
问题描述
HTTP PUT 请求的主体是一个 JSON 列表 - 像这样:
[item1, item2, item3, ...]
我无法改变这一点。(如果根是 JSON 对象而不是列表,则没有问题。)
使用 FastAPI 我似乎无法以正常方式访问此内容:
@router.put('/data')
def set_data(data: DataModel): # This doesn't work; how do I even declare DataModel?
我找到了以下解决方法,这似乎是一个非常丑陋的 hack:
class DataModel(BaseModel):
__root__: List[str]
from fastAPI import Request
@router.put('/data')
async def set_data(request: Request): # Get the request object directly
data = DataModel(__root__=await request.json())
这肯定不是实现这一目标的“批准”方式。我已经浏览了 FastAPI 和 pydantic 的文档。我错过了什么?
解决方案
从模型角度下降到基元
在 FastAPI 中,您派生BaseModel
来描述您发送和接收的数据模型(即,FastAPI 还为您从主体解析并转换为 Python 对象)。此外,它依赖于pydantic
.
from typing import List
from pydantic import BaseModel
class Item(BaseModel):
name: str
class ItemList(BaseModel):
items: List[Item]
def process_item_list(items: ItemList):
pass
这个例子将能够解析 JSON
{"items": [{"name": "John"}, {"name": "Mary"}]}
在您的情况下 - 根据您的列表条目的形状- 您还需要进行适当的类型建模,但您希望直接接收和处理列表,而不需要 JSON dict 包装器。你可以去:
from typing import List
from pydantic import BaseModel
class Item(BaseModel):
name: str
def process_item_list(items: List[Item]):
pass
它现在能够处理 JSON,如:
[{"name": "John"}, {"name": "Mary"}]
这可能是您正在寻找的内容,最后一次调整取决于您收到的列表中您的项目*的形状。如果是纯字符串,您还可以选择:
from typing import List
def process_item_list(items: List[str]):
pass
可以像处理 JSON
["John", "Mary"]
我概述了从模型到列表中的原语的路径,因为我认为如果需要在数据模型中增加更多复杂性,那么有必要知道这可以去哪里。