fastapi教程-进阶八（Handling Errors）

最新推荐文章于 2025-07-21 09:56:07 发布

一只路过的小码农cxy

最新推荐文章于 2025-07-21 09:56:07 发布

阅读量1.5k

点赞数

CC 4.0 BY-SA版权

分类专栏： fastapi 文章标签： python fastapi

本文链接：https://blog.csdn.net/weixin_40156487/article/details/108489837

本文详细介绍了如何在FastAPI中处理错误，包括使用HTTPException返回错误信息，定义异常处理器，重写默认异常处理器，利用结构体处理错误详情，以及FastAPI与Starlette的HTTPException差异。此外，还展示了如何重用FastAPI的异常处理器，以实现自定义错误处理逻辑。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

参考内容：

https://fastapi.tiangolo.com/

在很多情况下，在服务端出现错误时，我们需要告诉客户端出现了什么错误，例如：

客户端没有足够的权限进行该操作。
客户端无权访问该资源。
客户端尝试访问的项目不存在。

这时，我们需要返回给客户端400-499范围内的HTTP状态码。接下来介绍如何通过fastapi对服务端错误进行处理并返回给客户端HTTP状态码

HTTPException

如果希望将错误返回给客户端，可以使用HTTPException:

from fastapi import FastAPI, HTTPException

app = FastAPI()

items = {
   
   "foo": "The Foo Wrestlers"}


@app.get("/items/{item_id}")
async def read_item(item_id: str):
    if item_id not in items:
        raise HTTPException(status_code=404, detail="Item not found")
    return {
   
   "item": items[item_id]}

上面这个代码的含义是希望当查询的item_id不存在时，返回404状态码，并告诉客户端查询的id不存在。

我们先尝试请求http://127.0.0.1:8000/items/a，看看服务端会响应什么:
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-3i6smyYE-1599634775682)(evernotecid://FBE381A3-17C7-41D9-AA37-9C5F29FAB396/appyinxiangcom/20545635/ENResource/p221)]

回到代码中，我们注意到这里的HTTPException使用了raise，而不是return，这是为什么呢？

因为HTTPException本身是python的异常类，异常我们通常都是需要将它抛出，所以用了raise。这也就意味着，当我们触发了HTTPException这个异常，余下的代码将不会再执行，并且服务端会直接将错误通过HTTPException响应给客户端。

另外，当我们抛出HTTPException时，服务端会返回给我们:

{
   
   
  "detail": "Item not found"
}

如果我们想返回更具体的错误信息，可以对detail进行修改，它不仅可以接收字符串，也可以是json、dict、list等结构，例如我们修改代码:

from fastapi import FastAPI, HTTPException

app = FastAPI()

items = {
   
   "foo": "The Foo Wrestlers"}


@app.get("/items/{item_id}")
async def read_item(item_id: str):
    if item_id not in items:
        raise HTTPException(status_code=404, detail={
   
   'msg': "Item not found"})
    return {
   
   "item": items[item_id]}