Python Fastapi实现统一处理各种异常

 更新时间:2025年06月10日 10:24:51   作者:Sperains  
这篇文章主要为大家详细介绍了Python如何在Fastapi中实现统一处理各种异常,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下

在 FastAPI 中处理参数校验错误(通常由 Pydantic 模型或路径参数校验触发)需要使用自定义异常处理器捕获 RequestValidationError。以下是详细实现步骤:

1. 基础实现(返回标准错误结构)

from fastapi import FastAPI, Request, status
from fastapi.exceptions import RequestValidationError
from fastapi.responses import JSONResponse

app = FastAPI()

@app.exception_handler(RequestValidationError)
async def validation_exception_handler(request: Request, exc: RequestValidationError):
    return JSONResponse(
        status_code=status.HTTP_422_UNPROCESSABLE_ENTITY,
        content={
            "code": 422,
            "message": "参数校验失败",
            "errors": exc.errors()
        },
    )

# 示例路由
@app.get("/items/{item_id}")
async def read_item(item_id: int, q: str):
    return {"item_id": item_id, "q": q}

2. 自定义错误格式(简化输出)

@app.exception_handler(RequestValidationError)
async def custom_validation_handler(request: Request, exc: RequestValidationError):
    simplified_errors = []
    for error in exc.errors():
        # 提取关键信息
        simplified_errors.append({
            "field": "->".join(str(loc) for loc in error["loc"]),  # 错误字段路径
            "msg": error["msg"],
            "type": error["type"]
        })
    
    return JSONResponse(
        status_code=422,
        content={
            "error": "ValidationError",
            "detail": simplified_errors
        }
    )

3. 完整示例(含路由演示)

from pydantic import BaseModel, Field

class Item(BaseModel):
    name: str = Field(..., min_length=3)
    price: float = Field(gt=0)

@app.post("/items/")
async def create_item(item: Item):
    return item

# 测试无效请求
# curl -X POST 'http://localhost:8000/items/' \
# -H 'Content-Type: application/json' \
# -d '{"name": "AB", "price": -1}'

4. 处理自定义错误类型(扩展)

如果需要统一处理其他错误:

from fastapi import HTTPException

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

关键说明

1.错误信息结构

{
  "loc": ["body", "price"],
  "msg": "ensure this value is greater than 0",
  "type": "value_error.number.not_gt"
}
  • loc:错误位置(body/query/path/header等 + 字段路径)
  • msg:人类可读错误描述
  • type:错误类型标识符

2.HTTP 状态码

参数校验错误通常返回 422 Unprocessable Entity

路径参数错误(如 item_id: int 接收到字符串)会触发相同错误

3.调试信息: 生产环境中建议隐藏详细错误,可通过环境变量控制:

import os

@app.exception_handler(RequestValidationError)
async def handler(...):
    if os.getenv("ENV") == "prod":
        return JSONResponse(status_code=422, content={"error": "Invalid params"})
    else:
        # 返回完整错误

测试验证

使用无效参数请求示例路由,将得到类似响应:

{
  "code": 422,
  "message": "参数校验失败",
  "errors": [
    {
      "field": "body->name",
      "msg": "ensure this value has at least 3 characters",
      "type": "value_error.any_str.min_length"
    },
    {
      "field": "body->price",
      "msg": "ensure this value is greater than 0",
      "type": "value_error.number.not_gt"
    }
  ]
}

提示:FastAPI 自动生成的文档(Swagger UI)中的参数校验错误由内置处理器处理,自定义处理器不影响文档界面行为。

到此这篇关于Python Fastapi实现统一处理各种异常的文章就介绍到这了,更多相关Python Fastapi异常处理内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 用sqlalchemy构建Django连接池的实例

    用sqlalchemy构建Django连接池的实例

    今天小编就为大家分享一篇用sqlalchemy构建Django连接池的实例,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2019-08-08
  • python中Celery 异步任务队列的高级用法

    python中Celery 异步任务队列的高级用法

    Celery 是一个高效且可扩展的任务队列框架,通过合理配置任务重试、分组工作流、优先级管理以及监控工具,可以显著提升系统的可靠性和性能,感兴趣的可以了解一下
    2025-09-09
  • python2.7的flask框架之引用js&css等静态文件的实现方法

    python2.7的flask框架之引用js&css等静态文件的实现方法

    今天小编就为大家分享一篇python2.7的flask框架之引用js&css等静态文件的实现方法,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2019-08-08
  • Python中逗号的三种作用实例分析

    Python中逗号的三种作用实例分析

    这篇文章主要介绍了Python中逗号的三种作用,实例分析了Python中的逗号在类型转换与打印输出时的使用技巧,需要的朋友可以参考下
    2015-06-06
  • Python图像处理之Hough变换检测直线

    Python图像处理之Hough变换检测直线

    霍夫变换是一种特征检测(feature extraction),被广泛应用在图像分析,本文将利用Hough变换实现直线检测,感兴趣的小伙伴可以了解一下
    2023-07-07
  • 使用Python简单实现去除彩色水印

    使用Python简单实现去除彩色水印

    这篇文章主要为大家详细介绍了如何使用Python简单实现去除彩色水印效果,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下
    2025-02-02
  • Keras实现Vision Transformer VIT模型示例详解

    Keras实现Vision Transformer VIT模型示例详解

    这篇文章主要为大家介绍了Keras实现Vision Transformer VIT模型示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-05-05
  • 解读什么是npy文件,为什么要用npy格式保存文件

    解读什么是npy文件,为什么要用npy格式保存文件

    这篇文章主要介绍了什么是npy文件,为什么要用npy格式保存文件这个问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-02-02
  • 用Python设计一个经典小游戏

    用Python设计一个经典小游戏

    本篇文章主要介绍如何用Python设计一个经典小游戏:猜大小。具有很好的参考价值。下面跟着小编一起来看下吧
    2017-05-05
  • Kotlin 中的 apply 函数用法详解

    Kotlin 中的 apply 函数用法详解

    apply 函数是 Kotlin 中一个十分方便的工具,它使得对对象进行初始化和配置变得更加简洁、清晰,通过与 Java 的对比,我们可以看出 Kotlin 在处理类似情况时具有更高的表现力和简洁性,本文给大家介绍Kotlin apply 函数的用法,感兴趣的朋友一起看看吧
    2024-03-03

最新评论