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

星晨姑娘_9445

星晨姑娘_9445

2026-01-17

191人浏览

原创

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
<p>class ErrorResponse(BaseModel):
code: int
message: str
detail: Optional[str] = None</p>

创建自定义异常类

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

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
<p>@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()
)</p>

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

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

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

Python 环境工具专业版
Python 环境工具专业版

Python 环境工具专业版功能概述Python 环境工具专业版是一项面向实际任务的技能。它将相关步骤、工具调用和结果整理方式集中到统一流程中,帮助使用者更快完成目标并减少重复操作。核心要点使用时应结合输入条件选择合适的执行方式,核对必要参数、依赖环境与输出内容,并按原始要求处理异常情况。该技能适合需要稳定复用相关能力的场景,可作为自动化工作流的一部分,也便于后续检查、调整和扩展。执行完成后建议检查结果是否符合预期,并保留必要记录。使用与执行同时注意输入完整性、执行条件和输出可用性。从功能定位来看,该技能

下载
@app.get("/items/{item_id}")
def read_item(item_id: int):
    if 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} 不存在"
        )
<h1>使用时</h1><p>raise NotFoundException("用户")</p>

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

大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

2023.08.07

2355

5

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.23

3882

1

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

2023.10.13

1296

3

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

2025.09.10

4499

7

Python FastAPI异步API开发_Python怎么用FastAPI构建异步API
Python FastAPI异步API开发_Python怎么用FastAPI构建异步API

Python FastAPI 异步开发利用 async/await 关键字,通过定义异步视图函数、使用异步数据库库 (如 databases)、异步 HTTP 客户端 (如 httpx),并结合后台任务队列(如 Celery)和异步依赖项,实现高效的 I/O 密集型 API,显著提升吞吐量和响应速度,尤其适用于处理数据库查询、网络请求等耗时操作,无需阻塞主线程。

2025.12.22

119

5

Python 微服务架构与 FastAPI 框架
Python 微服务架构与 FastAPI 框架

本专题系统讲解 Python 微服务架构设计与 FastAPI 框架应用,涵盖 FastAPI 的快速开发、路由与依赖注入、数据模型验证、API 文档自动生成、OAuth2 与 JWT 身份验证、异步支持、部署与扩展等。通过实际案例,帮助学习者掌握 使用 FastAPI 构建高效、可扩展的微服务应用,提高服务响应速度与系统可维护性。

2026.02.06

594

18

Python Web框架FastAPI 全栈开发教程合集
Python Web框架FastAPI 全栈开发教程合集

以 FastAPI 为核心,讲解现代 Python Web API 的高效开发方式,涵盖路由定义与路径参数/查询参数/请求体绑定、Pydantic 模型的数据校验与序列化、依赖注入(Depends)系统的分层设计、中间件与 CORS 配置、OAuth2 + JWT 认证流程、后台任务(BackgroundTasks)、WebSocket 实时通信、SQLAlchemy 异步 ORM 集成、自动生成 OpenAPI/Swagger 交互文

2026.05.09

776

23

Python FastAPI异步微服务与高性能接口设计
Python FastAPI异步微服务与高性能接口设计

本专题聚焦 Python FastAPI 框架在高性能接口与微服务开发中的应用,讲解异步请求处理、依赖注入机制、路由设计、数据库异步操作以及接口性能优化策略。结合实际项目案例,帮助开发者构建高并发、低延迟的现代化后端服务架构。

2026.06.16

659

12

Python FastAPI异步API开发_Python怎么用FastAPI构建异步API
Python FastAPI异步API开发_Python怎么用FastAPI构建异步API

Python FastAPI 异步开发利用 async/await 关键字,通过定义异步视图函数、使用异步数据库库 (如 databases)、异步 HTTP 客户端 (如 httpx),并结合后台任务队列(如 Celery)和异步依赖项,实现高效的 I/O 密集型 API,显著提升吞吐量和响应速度,尤其适用于处理数据库查询、网络请求等耗时操作,无需阻塞主线程。

2025.12.22

119

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程