Python 如何在 FastAPI 中返回具有特定 http 响应代码的 Pydantic 对象

发布于03月28日

我有一个终结点，它返回一个PYDANIC对象.然而，我希望在某些情况下响应代码不是200(例如，如果我的服务不正常).我如何使用FastAPI实现这一点？

class ServiceHealth(BaseModel):
    http_ok: bool = True
    database_ok: bool = False

    def is_everything_ok(self) -> bool:
        return self.http_ok and self.database_ok

@router.get("/health")
def health() -> ServiceHealth:
    return ServiceHealth()

推荐答案

你可以退还Response Directly美元.

例如，您可以使用JSONResponse并手动设置status:

@router.get("/health")
async def health() -> ServiceHealth:
    response = ServiceHealth()
    
    if response.is_everything_ok():
        return JSONResponse(content=response.dict(), status=200)
    return JSONResponse(content=response.dict(), status=500)

此外，您还可以从fastapi导入一个方便的status.py，其中包含所有可用的状态代码:

from fastapi import status

@router.get("/health")
async def health() -> ServiceHealth:
    response = ServiceHealth()
    
    if response.is_everything_ok():
        return JSONResponse(content=response.dict(), status=status.HTTP_200_OK)
    return JSONResponse(content=response.dict(), status=status.HTTP_500_INTERNAL_SERVER_ERROR)