FastAPI异步项目Pydantic验证错误及解决方法咨询

错误根源分析 #

1. 第一个错误：FastAPI无法直接将SQLAlchemy ORM模型作为响应类型，必须使用Pydantic模型完成数据序列化。2021年的教程适配的框架版本较旧，当时的写法在新版本中已不再兼容。
2. 第二个错误：DAL函数中返回的是方法引用q.scalars().all而非方法调用结果q.scalars().all()，导致返回值不是列表对象，触发Pydantic类型验证失败。

分步解决方案 #

1. 修正DAL层的返回逻辑

修改get_all_toilets函数，确保调用all()方法获取实际的Toilet列表：

async def get_all_toilets(self) -> List[Toilet]:
    q = await self.db_session.execute(select(Toilet).order_by(Toilet.id))
    # 调用all()方法获取结果列表，而非引用方法本身
    return q.scalars().all()

2. 定义独立的Pydantic响应模型

避免和SQLAlchemy的Toilet模型重名，创建专门的Pydantic模型用于响应序列化，并开启ORM模式：

from pydantic import BaseModel
from typing import List

# 命名为ToiletResponse避免与SQLAlchemy模型冲突
class ToiletResponse(BaseModel):
    id: int  # 需包含SQLAlchemy模型中的主键字段
    gedung: str
    rating: int
    lantai: int

    class Config:
        orm_mode = True

3. 修正路由的响应模型配置

在路由中指定response_model为Pydantic模型的列表，同时正确设置返回类型注解：

@app.get("/toilets", response_model=List[ToiletResponse])
async def get_all_toilets() -> List[Toilet]:
    async with async_session() as session:
        async with session.begin():
            toilet_dal = ToiletDAL(session)
            return await toilet_dal.get_all_toilets()

关键说明 #

• ORM模式的作用：orm_mode=True让Pydantic可以直接从SQLAlchemy ORM实例中读取数据，无需手动转换为字典。
• 响应模型的必要性：FastAPI通过response_model自动生成API文档、验证响应数据并完成序列化，必须使用Pydantic类型而非SQLAlchemy模型。
• 方法调用的细节：scalars().all()才会执行查询并返回结果列表，遗漏括号会返回方法对象，导致类型不匹配。

内容的提问来源于stack exchange，提问作者Heidi Renata Halim