0

0

fastapi 如何让错误响应统一使用自定义异常模型

舞夢輝影

舞夢輝影

发布时间:2026-01-17 21:30:59

|

151人浏览过

|

来源于php中文网

原创

FastAPI中统一错误响应需结合自定义异常类、@app.exception_handler()装饰器和Pydantic模型。先定义ErrorResponse模型,再创建继承Exception的APIException类,接着注册全局处理器返回JSONResponse,最后在路由中raise实例即可输出标准化错误。

fastapi 如何让错误响应统一使用自定义异常模型

FastAPI 中让错误响应统一使用自定义异常模型,核心是结合 Exception 类、@app.exception_handler() 装饰器和 Pydantic 模型三者完成标准化输出。

定义统一的错误响应模型

先用 Pydantic 创建一个结构清晰的错误响应模型,例如包含状态码、错误码、消息和可选详情:

from pydantic import BaseModel
from typing import Optional

class ErrorResponse(BaseModel): code: int message: str detail: Optional[str] = None

创建自定义异常类

继承 Python 的 Exception,并携带必要字段(如 status_codecodemessage),方便后续处理器提取:

class APIException(Exception):
    def __init__(self, status_code: int, code: int, message: str, detail: str = None):
        self.status_code = status_code
        self.code = code
        self.message = message
        self.detail = detail

注册全局异常处理器

使用 @app.exception_handler(APIException) 拦截所有该类型异常,并返回符合 ErrorResponse 模型的 JSON 响应:

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

@app.exception_handler(APIException) async def api_exception_handler(request: Request, exc: APIException): return JSONResponse( status_code=exc.status_code, content=ErrorResponse( code=exc.code, message=exc.message, detail=exc.detail ).dict() )

注意:这个处理器只捕获 APIException 及其子类。若需统一处理所有未捕获异常(如 422 验证错误),可额外注册 RequestValidationError 或通用 Exception 处理器,但建议保持语义明确,避免掩盖开发问题。

路由中主动抛出自定义异常

直接 raise 实例即可,FastAPI 会自动交由对应 handler 处理:

eMart 网店系统
eMart 网店系统

功能列表:底层程序与前台页面分离的效果,对页面的修改无需改动任何程序代码。完善的标签系统,支持自定义标签,公用标签,快捷标签,动态标签,静态标签等等,支持标签内的vbs语法,原则上运用这些标签可以制作出任何想要的页面效果。兼容原来的栏目系统,可以很方便的插入一个栏目或者一个栏目组到页面的任何位置。底层模版解析程序具有非常高的效率,稳定性和容错性,即使模版中有错误的标签也不会影响页面的显示。所有的标

下载
@app.get("/items/{item_id}")
def read_item(item_id: int):
    if item_id < 1:
        raise APIException(
            status_code=400,
            code=1001,
            message="无效的 item ID",
            detail="item_id 必须大于 0"
        )
    return {"id": item_id}

此时响应体为标准 JSON:

{
  "code": 1001,
  "message": "无效的 item ID",
  "detail": "item_id 必须大于 0"
}

状态码也正确设为 400。

进阶:支持多种错误类型(可选)

可定义不同业务异常子类,复用同一 handler:

class NotFoundException(APIException):
    def __init__(self, resource: str):
        super().__init__(
            status_code=404,
            code=2001,
            message=f"{resource} 不存在"
        )

使用时

raise NotFoundException("用户")

这样既保持统一格式,又提升代码可读性和维护性。

相关专题

更多
python开发工具
python开发工具

php中文网为大家提供各种python开发工具,好的开发工具,可帮助开发者攻克编程学习中的基础障碍,理解每一行源代码在程序执行时在计算机中的过程。php中文网还为大家带来python相关课程以及相关文章等内容,供大家免费下载使用。

758

2023.06.15

python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

639

2023.07.20

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

761

2023.07.25

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

618

2023.07.31

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

1265

2023.08.03

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

548

2023.08.04

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

579

2023.08.04

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

708

2023.08.11

高德地图升级方法汇总
高德地图升级方法汇总

本专题整合了高德地图升级相关教程,阅读专题下面的文章了解更多详细内容。

43

2026.01.16

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

相关下载

更多

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
最新Python教程 从入门到精通
最新Python教程 从入门到精通

共4课时 | 3.1万人学习

Django 教程
Django 教程

共28课时 | 3.2万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.2万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号