讲师中心 微信公众号
AI工具推荐 视频效率加速

如何在Python FastAPI框架中捕获并返回自定义JSON错误响应?

千丽大大_5919

千丽大大_5919

发布时间:2026-07-16 11:17:37

|

217人浏览过

|

来源于php中文网

原创

FastAPI中需通过app.add_exception_handler()注册全局异常处理器,统一返回结构化JSON响应;自定义异常类(如BusinessError)可扩展业务字段,避免仅用HTTPException的局限性。

如何在python fastapi框架中捕获并返回自定义json错误响应?

FastAPI 中如何用 ExceptionHandler 捕获全局异常

FastAPI 默认把未处理的异常转成 500 响应,且返回 HTML 错误页(开发模式)或空响应(生产模式),这不符合 API 的 JSON 错误约定。必须显式注册 ExceptionHandler 才能统一输出结构化 JSON。

关键点是:不能靠 try/except 包裹每个路由,而要用 app.add_exception_handler() 注册函数,让 FastAPI 自动调用它处理指定异常类型。

  • 注册时传入异常类(如 HTTPExceptionValueError 或自定义异常)和处理函数
  • 处理函数签名必须是 async def handler(request: Request, exc: Exception) -> JSONResponse
  • 函数内必须返回 JSONResponse,不能用 return {"detail": ...}(那会触发默认序列化,可能丢 status_code)

如何定义并抛出自定义异常类

直接 raise HTTPException(status_code=400, detail="xxx") 虽然可行,但难以区分业务错误类型、不方便统一加字段(如 error_code)、也不利于日志分类。推荐定义继承自 Exception 的类,再配一个对应的 handler。

例如定义 BusinessError

立即学习Python免费学习笔记(深入)”;

class BusinessError(Exception):
    def __init__(self, error_code: str, message: str, status_code: int = 400):
        self.error_code = error_code
        self.message = message
        self.status_code = status_code

在路由中直接 raise:

FastAPI 0.140.10
FastAPI 0.140.10

FastAPI 0.140.10 是 FastAPI 的官方历史稳定版本,下载地址使用 PyPI wheel 包直链,适合指定版本安装和项目环境复现。

下载
@app.get("/user/{uid}")
def get_user(uid: str):
    if not uid.isdigit():
        raise BusinessError("INVALID_UID", "UID must be numeric", status_code=422)
    return {"id": uid}

为什么不能只靠 HTTPException?

HTTPException 是 FastAPI 提供的快捷工具,但它只支持 status_codedetail 两个字段,无法扩展业务字段(比如 trace_iderror_codehint)。一旦你需要返回类似 {"error_code": "AUTH_FAILED", "message": "Token expired", "retry_after": 60} 这样的结构,HTTPException 就不够用了。

  • HTTPExceptionheadersstatus_code 可以传,但响应体固定为 {"detail": "..."} ,无法改键名
  • 若强行用 JSONResponse 替换整个响应,会绕过 FastAPI 的异常传播链,导致中间件(如 Sentry 日志)收不到原始异常对象
  • 混合使用 HTTPException 和自定义异常会让错误处理逻辑分散,后期难维护

返回 JSON 响应时容易忽略的细节

最常踩的坑是:用 return {"error_code": "...", "message": ...} 直接返回 dict。这看似能工作,但 FastAPI 会把它当正常响应体序列化,status_code 仍为 200,前端根本收不到错误信号。

正确做法是显式构造 JSONResponse 并传入 status_code

from fastapi.responses import JSONResponse

@app.exception_handler(BusinessError)
async def business_error_handler(request: Request, exc: BusinessError):
    return JSONResponse(
        status_code=exc.status_code,
        content={
            "error_code": exc.error_code,
            "message": exc.message,
            "path": request.url.path,
        },
    )

注意:JSONResponse 不会自动加 Content-Type: application/json 吗?会的,它默认设置;但如果你手动设置了 media_type,要确保是 "application/json",否则某些客户端可能解析失败。

另外,别在 handler 里 raise 新异常——这会导致二次崩溃,且无法捕获。

热门AI工具

更多
WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

相关专题

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

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

1531

2023.07.20

python能做什么
python能做什么

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

3584

2023.07.25

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

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

1549

2023.07.31

python教程
python教程

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

20337

2023.08.03

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

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

2527

2023.08.04

python eval
python eval

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

2587

2023.08.04

scratch和python区别
scratch和python区别

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

1063

2023.08.11

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

576

2023.08.10

AI视频生成软件推荐
AI视频生成软件推荐

本专题汇总了当前主流的AI视频生成软件推荐与排行榜单,涵盖seko、AniShort、剧云、Lovart、LiblibAI及立刻mv等热门工具。同时整理了各软件在文生视频、图生视频、时长限制、画质表现及免费额度等方面的差异对比,助您快速选对适合创作需求的AI视频生成工具。

140

2026.09.16

热门下载

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

精品课程

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn