跳到内容

使用旧的 403 认证错误状态码

在 FastAPI 版本 0.122.0 之前,当集成的安全工具在认证失败后向客户端返回错误时,它们会使用 HTTP 状态码 403 Forbidden

从 FastAPI 版本 0.122.0 开始,它们使用更合适 HTTP 状态码 401 Unauthorized,并返回一个合理的 WWW-Authenticate 头部信息,遵循 HTTP 规范,RFC 7235RFC 9110

但是,如果出于某种原因,您的客户端依赖于旧的行为,您可以通过在您的安全类中重写 make_not_authenticated_error 方法来恢复它。

例如,您可以创建一个 HTTPBearer 的子类,它返回 403 Forbidden 错误而不是默认的 401 Unauthorized 错误

from typing import Annotated

from fastapi import Depends, FastAPI, HTTPException, status
from fastapi.security import HTTPAuthorizationCredentials, HTTPBearer

app = FastAPI()


class HTTPBearer403(HTTPBearer):
    def make_not_authenticated_error(self) -> HTTPException:
        return HTTPException(
            status_code=status.HTTP_403_FORBIDDEN, detail="Not authenticated"
        )


CredentialsDep = Annotated[HTTPAuthorizationCredentials, Depends(HTTPBearer403())]


@app.get("/me")
def read_me(credentials: CredentialsDep):
    return {"message": "You are authenticated", "token": credentials.credentials}

提示

请注意,该函数返回异常实例,而不是抛出它。抛出异常是在内部代码的其他部分完成的。