使用旧的 403 认证错误状态码¶
在 FastAPI 0.122.0 版本之前,当内置的安全工具在认证失败后向客户端返回错误时,会使用 HTTP 状态码 403 Forbidden。
从 FastAPI 0.122.0 版本开始,它们改用更合适的 HTTP 状态码 401 Unauthorized,并在响应中返回合理的 WWW-Authenticate 头,遵循 HTTP 规范,RFC 7235、RFC 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}
提示
注意该函数返回的是异常实例,而不是直接抛出它。抛出操作由其余的内部代码完成。