使用Python FastAPI实现多条目查询时遭遇参数错误问题

核心错误点 #

1. 错误使用Query接收Pydantic模型：Query仅用于定义单个查询参数，不能直接包裹整个Pydantic模型，FastAPI无法解析这种结构，导致参数校验失败。
2. 默认值设置错误：default=select(PropsTable)是SQLAlchemy的查询语句，并非Props类型的合法默认值，完全不符合查询参数的要求。
3. 潜在缺失导入：Pydantic模型中的Optional需要从typing模块导入，否则会引发语法错误。

修复步骤 #

1. 修正Pydantic模型 #

确保导入Optional，并给字段设置合理默认值：

from typing import Optional
from pydantic import BaseModel

class Props(BaseModel):
    query: Optional[str] = None  # 显式设置默认值None，避免空值报错

2. 修正路由函数 #

使用Depends（或直接将模型作为参数）接收查询参数，替换错误的Query用法：

from fastapi import Depends
from sqlalchemy.orm import Session
from sqlalchemy import select
# 替换为你的实际模块路径
from your_db_module import get_session, PropsTable

def get_props_query(
    *,
    session: Session = Depends(get_session),
    # 用Depends让FastAPI自动解析查询参数到Props模型
    props: Optional[Props] = Depends()
):
    # 构建基础查询
    stmt = select(PropsTable)
    
    # 根据查询条件过滤结果
    if props and props.query:
        # 替换为你的实际字段和过滤逻辑，比如模糊匹配
        stmt = stmt.where(PropsTable.target_column.like(f"%{props.query}%"))
    
    # 执行查询并返回结果
    return session.execute(stmt).scalars().all()

或者更简洁的写法（直接将模型作为参数，FastAPI会自动处理）：

def get_props_query(
    *,
    session: Session = Depends(get_session),
    props: Optional[Props] = None
):
    # 同上的查询逻辑

说明 #

当需要接收复杂结构的查询参数时，直接使用Pydantic模型作为路由参数（或通过Depends注入）即可，FastAPI会自动将URL中的查询参数（如?query=xxx）映射到模型字段中。

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