四、Python框架篇: FastApi-错误处理

最新推荐文章于 2026-05-22 16:21:43 发布

原创

最新推荐文章于 2026-05-22 16:21:43 发布 · 1.2k 阅读

标签

#python #fastapi #windows

1.验证错误

（1）默认返回

当传参不符合模型验证规则时，默认错误信息和格式返回如下:

{
  "detail": [
    {
      "type": "list_type",
      "loc": [
        "body",
        "likes"
      ],
      "msg": "Input should be a valid list",
      "input": "足球"
    }
  ]
}

在上篇文章FastApi-响应模型中，我们强调的是接口对外输出结构应该一致，所以即便参数错误应该输出以下结构:

{
    "code":-1,
    "msg":"具体错误信息...",
    "data": null
}

按照官方文档说法，我们需要自定义错误处理器，并以此来覆盖框架默认的异常处理器，参数验证错误处理器默认走的RequestValidationError,所以覆盖它就行，下面是实现步骤

（2）自定义处理器

新建包 errors，并新增文件 validation_error.py，文件内容如下：

from fastapi import Request, status
from fastapi.exceptions import RequestValidationError
from fastapi.responses import JSONResponse
from parameter import http_resp
from fastapi.encoders import jsonable_encoder

async def validationExceptionHandler(request: Request, exc: RequestValidationError):
    """ 自定义参数验证异常错误"""
    print("自定义参数验证异常错误")
    errMsg = ""
    for error in exc.errors():
        errMsg += ".".join(error.get("loc")) + ":" + error.get("msg") + ";"


    # 这里response.ResponseFail是上篇文章中的内容
    return JSONResponse(status_code=status.HTTP_200_OK, content=jsonable_encoder(http_resp.ResponseFail(errMsg)))

在包errors/__init__.py引用,并封装统一注册方法：

from fastapi import FastAPI
from validation_error import validationExceptionHandler
from fastapi.exceptions import RequestValidationError

def registerCustomErrorHandle(server: FastAPI):
    """ 统一注册自定义错误处理器"""
    # 注册参数验证错误,并覆盖模式RequestValidationError
    server.add_exception_handler(RequestValidationError, validationExceptionHandler)

（3）注册与覆盖

在main.py中调用registerCustomErrorHandle