FastAPI中怎么实现API错误处理

571
2024/6/4 16:43:59
栏目: 编程语言
开发者测试专用服务器限时活动,0元免费领,库存有限,领完即止! 点击查看>>

在FastAPI中,可以使用HTTPException类来实现API错误处理。通过抛出HTTPException异常,可以返回自定义的HTTP状态码和错误信息。

示例代码如下:

from fastapi import FastAPI, HTTPException

app = FastAPI()

@app.get("/items/{item_id}")
def read_item(item_id: int):
    if item_id == 0:
        raise HTTPException(status_code=404, detail="Item not found")
    return {"item_id": item_id}

在上面的例子中,如果传入的item_id为0,就会抛出一个404错误,返回"Item not found"的错误信息。

除了使用HTTPException类外,还可以通过异常处理器来处理API错误。示例代码如下:

from fastapi import FastAPI, HTTPException
from fastapi.responses import JSONResponse

app = FastAPI()

@app.exception_handler(HTTPException)
async def http_exception_handler(request, exc):
    return JSONResponse(
        status_code=exc.status_code,
        content={"detail": exc.detail}
    )

@app.get("/items/{item_id}")
def read_item(item_id: int):
    if item_id == 0:
        raise HTTPException(status_code=404, detail="Item not found")
    return {"item_id": item_id}

在上面的例子中,定义了一个异常处理器http_exception_handler,用来处理HTTPException异常。当抛出HTTPException异常时,会调用http_exception_handler处理器来返回自定义的错误信息。

通过以上两种方法,可以实现API错误处理并返回自定义的错误信息。

辰迅云「云服务器」,即开即用、新一代英特尔至强铂金CPU、三副本存储NVMe SSD云盘,价格低至29元/月。点击查看>>

推荐阅读: FastAPI中怎么实现预加载