FastAPI如何调整接口返回格式为response包裹的对象数组

问题复现 #

你当前编写的路由代码存在两处核心问题：一是依赖注入语句语法不完整，二是直接返回ORM查询结果列表，没有按要求包裹外层response字段。
原始代码如下：

@app.get("/{subject}")
def getResult(subject:str, db:Session = Depends(get_db): # 此处缺失右括号，运行时会直接触发语法错误
    quesnQuery = db.query(models.Post).filter(
        func.lower(models.Post.category) == func.lower(subject)
    ).order_by(func.random())
    quesn = quesnQuery.limit(10).all()
    return quesn

直接返回无外层包裹的数组时，查询无结果就会出现你看到的0:[]格式，不符合预期要求。

具体实现步骤 #

• 修复语法错误，补全依赖注入参数的闭合括号
• 将查询到的结果列表封装到键为response的字典中返回，FastAPI会自动将字典序列化为标准JSON格式
• （推荐）使用Pydantic模型定义响应结构，避免ORM对象直接序列化的异常，同时可以精确控制返回字段、过滤敏感信息

最简实现代码 #

不需要额外引入其他依赖，直接修改返回值即可满足格式要求：

@app.get("/{subject}")
def getResult(subject:str, db:Session = Depends(get_db)): # 补全右括号修复语法问题
    quesnQuery = db.query(models.Post).filter(
        func.lower(models.Post.category) == func.lower(subject)
    ).order_by(func.random())
    quesn_list = quesnQuery.limit(10).all()
    # 封装为要求的结构返回
    return {"response": quesn_list}

如果对应分类下有匹配数据，返回格式就是你预期的{"response": [{},{},...]} ，无匹配数据时返回{"response": []}，结构保持统一。

规范实现（推荐生产环境使用） #

通过Pydantic定义响应模型，自动完成ORM对象到JSON的序列化，同时可以按需过滤不需要返回的内部字段：

from pydantic import BaseModel
from typing import List

# 定义单条帖子的返回字段，可根据实际模型字段增减
class PostItem(BaseModel):
    id: int
    title: str
    content: str
    category: str

    class Config:
        orm_mode = True # 开启后支持直接读取SQLAlchemy模型属性，无需手动转字典

# 定义接口整体响应结构
class ResultResp(BaseModel):
    response: List[PostItem]

@app.get("/{subject}", response_model=ResultResp)
def getResult(subject:str, db:Session = Depends(get_db)):
    quesnQuery = db.query(models.Post).filter(
        func.lower(models.Post.category) == func.lower(subject)
    ).order_by(func.random())
    quesn_list = quesnQuery.limit(10).all()
    return {"response": quesn_list}

注意事项 #

• 如果返回结果中response对应为空数组，先检查传入的subject参数是否和数据库中存储的分类匹配，代码中func.lower()已经做了大小写兼容，不会因为大小写差异导致查询失败
• 不要直接返回未做序列化配置的SQLAlchemy模型对象，否则可能出现序列化失败、数据库内部字段泄露的问题

内容的提问来源于stack exchange，提问作者Bhavya Sharma