FastAPI+pydantic+SQLAlchemy返回多个数据

问题#

比如在ORM中查询all, 那么使用pydantic.from_orm获取对应的数据呢?

解决思路#

只需要, 将一个字段对应为List, 元素为对应SQLAlchemy的pydantic模型即可
pydantic模型要设置orm_mode为True

例子#

schemas.py 定义模型

# 对应ORM的数据
class Note(BaseModel):
    nid: int
    content: str
    created_at: datetime
    updated_at: datetime
 
    class Config:
        orm_mode = True  # 需要设置orm_mode为True
 
 
# 要返回的模型
class Notes(BaseModel):
    status: str
    msg: str
    data: List[Note]
 

crud.py 用于增删改查

def query_note_all(session: Session, offset: int, limit: int) -> List[schemas.Note]:
    """
    查询note全部数据
    :param session: ORM 的 session
    :param offset: 跳过多少数据
    :param limit: 取多少条数据
    :return: Note列表
    """
    notes = session.execute(
        select(Note).where(Note.is_active == True).limit(limit).offset(offset)
    ).scalars().all()
 
    return notes

注意这里的scalars().all()等同于1.x版本的query().all(), 见: 1.x与2.0的ORM接口对比

main.py 用于定义FastAPI代码

@app.get("/data", response_model=schemas.Notes)
async def get_note_date(offset: Optional[int] = 0, limit: Optional[int] = 10,
                        session: Session = Depends(get_session)):
 
    notes = crud.query_note_all(session, offset=offset, limit=limit)
 
    return {
        "status": 1,
        "data": notes,
        "msg": "获取成功",
    }