嵌套 Pydantic Model 使用 FastAPI 返回错误：需要字段（type=value_error.missing）

Question

我在使用FastAPI和Pydantic 时遇到了问题。 我尝试根据我的 Pydantic model 返回记录列表。

这是 SQLAlchemy 元数据：

from sqlalchemy import MetaData, Table, Column, Integer, JSON, Boolean
from sqlalchemy.sql import expression

metadata = MetaData()

CustomLayers = Table(
    "custom_layers",
    metadata,
    Column("id", Integer, primary_key=True),
    Column("data", JSON),
    Column("is_public", Boolean, default=expression.false()),
    Column("user_id", Integer),
)

这是“对应的”pydantic model：

from geojson_pydantic.features import FeatureCollection
from pydantic import BaseModel

class CustomLayerResponse(BaseModel):
    is_public: bool
    data: FeatureCollection
    user_id: int
    id: int

    class Config:
        orm_mode = True

这是我的路线：

@router.get("/", response_model=List[CustomLayerResponse], status_code=status.HTTP_200_OK)
async def retrieve_by_user(user_id: int):
    layer_records = await customlayers_repository.retrieve_by_user_id(user_id)
    return layer_records

这是使用数据库库（基于 SQL Alchemy）的检索操作

async def retrieve_by_user_id(user_id: int):
    query = CustomLayersTable.select().where(user_id == CustomLayersTable.c.user_id)
    return await database.fetch_all(query=query)

但是当我运行它时，我从 pydantic 得到了一堆ValidationError说：

response -> 7 -> id
  field required (type=value_error.missing)
response -> 7 -> user_id
  field required (type=value_error.missing)
response -> 7 -> is_public
  field required (type=value_error.missing)
response -> 7 -> data
  field required (type=value_error.missing)

但真正奇怪的是，如果我遍历 ORM 返回的数据库记录并以这种方式手动创建 pydantic 模式的实例：

@router.get("/", response_model=List[CustomLayerResponse], status_code=status.HTTP_200_OK)
async def retrieve_by_user(user_id: int):
    layer_records = await customlayers_repository.retrieve_by_user_id(user_id)
    response = []
    for l in layer_records:
        manual_instance = CustomLayerResponse(data=FeatureCollection.parse_raw(l.get("data")),
                                user_id=l.get("user_id"),
                                id=l.get("id"),
                                is_public=l.get("is_public"))
        response.append(manual_instance)
    return response

然后一切都按预期工作，我得到了CustomLayerResponse列表作为响应。

所以我想知道来自 pydantic model 的“自动”验证可能是什么问题（由 FastAPI 提供的response_model参数提供的，我在这里设置为List[CustomLayerResponse] ）？

Answer 1

您的数据字段应使用扩展 FeatureCollection 和 BaseModel 的 class 以便您也可以将其 Config 子类字段 orm_true 设置为 true。

我还没有使用 FeatureCollection 对其进行测试，但类似的事情发生在我身上。