0

0

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

舞夢輝影

舞夢輝影

发布时间:2026-01-21 18:06:01

|

191人浏览过

|

来源于php中文网

原创

FastAPI可通过异常处理器与Pydantic模型统一错误响应格式为{"code":int,"message":str,"details":Any};需定义ErrorResponse模型、注册HTTPException/Exception/自定义异常处理器,并在路由中用responses参数声明OpenAPI错误结构。

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

FastAPI 中可以通过异常处理器(exception handlers)和 Pydantic 模型配合,实现所有错误响应都统一返回你定义的结构化错误格式,比如 {"code": 400, "message": "xxx", "details": {...}}

定义统一错误响应模型

先用 Pydantic 创建一个标准错误响应模型,它将作为所有异常响应的序列化格式:

from pydantic import BaseModel
from typing import Optional, Any

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

注册全局异常处理器

使用 app.add_exception_handler() 注册对 Exception 或具体异常(如 HTTPException、自定义异常)的处理逻辑。推荐按需注册两类:

  • 处理 FastAPI 内置的 HTTPException:提取 status_code 和 detail
  • 处理未捕获的通用异常(可选):记录日志并返回 500 错误
from fastapi import FastAPI, HTTPException, Request
from fastapi.responses import JSONResponse

app = FastAPI()

@app.exception_handler(HTTPException) async def http_exception_handler(request: Request, exc: HTTPException) -> JSONResponse: return JSONResponse( status_code=exc.status_code, content=ErrorResponse( code=exc.status_code, message=exc.detail, details=getattr(exc, "headers", None) or getattr(exc, "data", None) ).model_dump() )

@app.exception_handler(Exception) async def unhandled_exception_handler(request: Request, exc: Exception) -> JSONResponse:

生产环境建议只返回泛化错误,避免泄露敏感信息

return JSONResponse(
    status_code=500,
    content=ErrorResponse(
        code=500,
        message="Internal server error",
        details=None
    ).model_dump()
)

eMart 网店系统
eMart 网店系统

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

下载

定义并抛出自定义业务异常

为不同业务场景创建继承自 Exception 的异常类,并在视图中主动 raise。这样既能保持逻辑清晰,又可被统一处理器捕获:

class ValidationError(Exception):
    def __init__(self, message: str, details: Optional[dict] = None):
        self.message = message
        self.details = details
        self.status_code = 422

在路由中使用

@app.get("/items/{item_id}") def get_item(item_id: int): if item_id < 1: raise ValidationError("Item ID must be positive", {"field": "item_id"}) return {"id": item_id}

然后为其注册专属处理器(注意注册顺序:更具体的异常要先注册):

@app.exception_handler(ValidationError)
async def validation_error_handler(request: Request, exc: ValidationError) -> JSONResponse:
    return JSONResponse(
        status_code=exc.status_code,
        content=ErrorResponse(
            code=exc.status_code,
            message=exc.message,
            details=exc.details
        ).model_dump()
    )

让 OpenAPI 文档也反映统一错误结构

默认情况下,FastAPI 不会自动把异常响应写入 OpenAPI schema。你可以通过 responses 参数显式声明,并复用 ErrorResponse 模型:

@app.get(
    "/users/{user_id}",
    responses={
        404: {"model": ErrorResponse, "description": "User not found"},
        422: {"model": ErrorResponse, "description": "Validation failed"},
    }
)
def get_user(user_id: int):
    if user_id != 123:
        raise HTTPException(status_code=404, detail="User not found")
    return {"name": "Alice"}

这样 Swagger UI 就会显示对应状态码的错误响应结构,提升 API 可用性与前端协作效率。

相关专题

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

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

27

2025.12.22

string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

338

2023.08.02

int占多少字节
int占多少字节

int占4个字节,意味着一个int变量可以存储范围在-2,147,483,648到2,147,483,647之间的整数值,在某些情况下也可能是2个字节或8个字节,int是一种常用的数据类型,用于表示整数,需要根据具体情况选择合适的数据类型,以确保程序的正确性和性能。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

542

2024.08.29

c++怎么把double转成int
c++怎么把double转成int

本专题整合了 c++ double相关教程,阅读专题下面的文章了解更多详细内容。

53

2025.08.29

C++中int的含义
C++中int的含义

本专题整合了C++中int相关内容,阅读专题下面的文章了解更多详细内容。

197

2025.08.29

Java编译相关教程合集
Java编译相关教程合集

本专题整合了Java编译相关教程,阅读专题下面的文章了解更多详细内容。

9

2026.01.21

C++多线程相关合集
C++多线程相关合集

本专题整合了C++多线程相关教程,阅读专题下面的的文章了解更多详细内容。

3

2026.01.21

无人机驾驶证报考 uom民用无人机综合管理平台官网
无人机驾驶证报考 uom民用无人机综合管理平台官网

无人机驾驶证(CAAC执照)报考需年满16周岁,初中以上学历,身体健康(矫正视力1.0以上,无严重疾病),且无犯罪记录。个人需通过民航局授权的训练机构报名,经理论(法规、原理)、模拟飞行、实操(GPS/姿态模式)及地面站训练后考试合格,通常15-25天拿证。

13

2026.01.21

Python多线程合集
Python多线程合集

本专题整合了Python多线程相关教程,阅读专题下面的文章了解更多详细内容。

1

2026.01.21

热门下载

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

相关下载

更多

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 8.4万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 3.2万人学习

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

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