如何在FastAPI Swagger页面隐藏Request对象

问题描述 #

在FastAPI实现中，使用两个装饰器分别处理异常返回优雅错误响应、做访问控制。为检查请求状态和请求头，需将Request对象作为端点参数传入，但该参数会显示在Swagger页面中，希望将其隐藏。尝试过返回None的虚拟Depends方法、Query、Header均无效，因为Request对象是Pydantic模型，不支持自定义处理器。相关代码示例：

@router.get(
        "/overview",
        response_model=Union[ModelOverview],
        responses={HTTPStatus.BAD_REQUEST.value: {api_c.MODEL: Message}},
    )
@api_error_handler()
@requires_access_levels(access_levels=[
            api_c.REQUIRED_ACCESSES
        ])
def get_tasks_overview(
    self,
    request: Request, # Hide this from Swagger
    start_date: str = None,
    end_date: str = None,
    user_id: str = None,
    group_by: str = None,
) -> JSONResponse:

解决方案 #

核心思路是通过Depends注入Request对象，而非直接将其作为端点参数声明，这样就不会被Swagger的OpenAPI schema收录。

方法一：直接使用Depends()注入 #

修改端点函数的request参数声明，用Depends()注入Request对象：

from fastapi import Request, Depends

# ... 其他装饰器和导入 ...

@router.get(
        "/overview",
        response_model=Union[ModelOverview],
        responses={HTTPStatus.BAD_REQUEST.value: {api_c.MODEL: Message}},
    )
@api_error_handler()
@requires_access_levels(access_levels=[
            api_c.REQUIRED_ACCESSES
        ])
def get_tasks_overview(
    self,
    request: Request = Depends(),  # 该参数不会显示在Swagger中
    start_date: str = None,
    end_date: str = None,
    user_id: str = None,
    group_by: str = None,
) -> JSONResponse:
    # 正常使用request对象，比如获取请求头
    # token = request.headers.get("X-User-Token")

方法二：自定义依赖函数注入（更清晰） #

如果需要对Request做预处理，可以封装成独立的依赖函数，同样不会暴露到Swagger：

from fastapi import Request, Depends

def get_current_request(request: Request) -> Request:
    # 可添加预处理逻辑，比如验证请求头格式
    return request

# ... 端点函数 ...
def get_tasks_overview(
    self,
    request: Request = Depends(get_current_request),  # 通过依赖函数注入
    start_date: str = None,
    end_date: str = None,
    user_id: str = None,
    group_by: str = None,
) -> JSONResponse:
    # 正常使用request对象

以上两种方式都能让你正常获取Request对象用于请求状态、头信息的检查，同时不会在Swagger文档中显示该参数。

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