FastAPI中如何将response_model_exclude_none设为用户可传选项

完全可以让用户通过请求参数自主控制是否过滤响应中的None值字段，核心思路是放弃在@router.get()装饰器中写死response_model_exclude_none配置，改为在请求处理阶段动态读取用户传入的控制参数，自定义序列化逻辑即可，以下是两种常用实现：

方案1：单路由自定义序列化（无侵入，适合少量路由场景） #

直接在路由处理函数中新增一个查询参数接收用户的控制开关，拿到响应模型实例后，根据参数值动态控制序列化规则，最终返回自定义JSON响应即可。
示例代码：

from fastapi import APIRouter, Query
from fastapi.responses import JSONResponse
from pydantic import BaseModel
from typing import Optional

class TestModel(BaseModel):
    model_option: str
    # 新增可选None字段用于验证过滤效果
    optional_field: Optional[str] = None

router = APIRouter(prefix="/hello", tags=["test"])

@router.get("/world", response_model=TestModel)
def return_model(
    model_option: str,
    # 定义用户可控参数，默认关闭None值过滤
    exclude_none: bool = Query(default=False, description="是否过滤响应中值为None的字段")
):
    resp = TestModel(model_option=model_option)
    # Pydantic V2用model_dump，V1版本把model_dump替换为dict即可
    return JSONResponse(content=resp.model_dump(exclude_none=exclude_none))

使用效果：

• 请求地址带?exclude_none=true时，响应自动过滤所有值为None的字段
• 不传该参数或传?exclude_none=false时，响应返回全量字段，保留None值

方案2：自定义路由类（适合多路由统一支持该能力） #

如果项目中大量路由都需要支持用户动态控制None值过滤，可以通过自定义路由类+依赖注入的方式统一实现，不需要每个路由单独写序列化逻辑：

from fastapi import APIRouter, Query, Request, Depends
from fastapi.responses import JSONResponse
from fastapi.routing import APIRoute
from fastapi.encoders import jsonable_encoder
from pydantic import BaseModel
from typing import Optional, Callable, Any

# 自定义路由类，拦截响应做动态序列化
class DynamicExcludeNoneRoute(APIRoute):
    def get_route_handler(self) -> Callable:
        original_handler = super().get_route_handler()
        async def wrapper(request: Request) -> Any:
            # 从请求状态读取用户传入的过滤开关
            exclude_none = getattr(request.state, "exclude_none", False)
            # 执行原路由逻辑拿到响应对象
            raw_resp = await original_handler(request)
            # 如果返回的是Pydantic模型实例，动态按规则序列化
            if isinstance(raw_resp, BaseModel):
                return JSONResponse(
                    content=jsonable_encoder(raw_resp, exclude_none=exclude_none)
                )
            return raw_resp
        return wrapper

# 通用依赖，接收用户传入的控制参数并存入请求状态
async def parse_exclude_none_flag(
    request: Request,
    exclude_none: bool = Query(default=False, description="是否过滤响应中值为None的字段")
):
    request.state.exclude_none = exclude_none

class TestModel(BaseModel):
    model_option: str
    optional_field: Optional[str] = None

# 初始化路由时指定自定义路由类
router = APIRouter(
    prefix="/hello",
    tags=["test"],
    route_class=DynamicExcludeNoneRoute
)

# 路由只需要加通用依赖即可，不需要单独写序列化逻辑
@router.get("/world", response_model=TestModel, dependencies=[Depends(parse_exclude_none_flag)])
def return_model(model_option: str):
    return TestModel(model_option=model_option)

注意：如果项目中响应可能返回列表、字典等非Pydantic模型类型，只需要在自定义路由的序列化逻辑里补充对应类型的处理分支即可。

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