ErrorHandler 美化 JSON API 错误响应与调试页面【异常美学】

雪夜

雪夜

2026-07-11

749人浏览

原创

json api错误响应不能直接返回raw error,因前端依赖结构化字段判断;必须满足:http状态码与status字段一致、顶层为{"errors":[...]}、每个errorobject含非空title和detail。

errorhandler 美化 json api 错误响应与调试页面【异常美学】

JSON API 错误响应为什么不能直接返回 raw error?

因为客户端(尤其是前端)依赖结构化字段做条件判断,Unexpected token 这类错误根本不是 JSON,而是 HTML 错误页混入响应体——说明服务端异常未被捕获,直接透出 500 页面。这类响应连 <code>JSON.parse() 都过不去,更别说提取 codedetail

真正可用的错误响应必须满足三点:

  • HTTP 状态码与 Status 字段一致(如 404 → "status": "404"
  • 顶层是 {"errors": [...]} 结构,不是 {"error": {...}} 或裸对象
  • 每个 ErrorObject 至少含 titledetail,且不为空字符串

用 Vue-JSON-Pretty 或 JSONVue 实时高亮错误字段

调试时别再手动折叠展开找 detail —— 工具能自动识别 errors 数组并高亮非 2xx 响应。Vue-JSON-Pretty 在 status ≥ 400 时默认切红色主题;JSONVue 插件遇到 "errors" 键会加粗显示、悬停提示路径 errors[0].detail

注意两个易踩坑点:

  • 如果后端返回的是单个 ErrorObject(没包在 errors 数组里),Vue-JSON-Pretty 不会触发错误模式,需确认是否漏了 ErrorsPayload 容器
  • JSONVue 对 meta 字段内容不做校验,但若 meta 里塞了函数或 undefined,会导致渲染失败——调试时先删掉 meta 再看主错误

FastAPI / Spring Boot / Rails 中统一注入 errors 字段

不要在每个路由里手拼 {"errors": [...]}。框架层该做的事就交给框架:

php版微信js-sdk支付接口类
php版微信js-sdk支付接口类

php版微信js-sdk支付接口类

下载
  • FastAPI:用 response_model=ErrorsPayload + 自定义 HTTPException 子类,重写 errors 方法返回 [ErrorObject(...)]
  • Spring Boot:在 @ControllerAdvice 里拦截 JSONAPIException,调用 new ErrorsPayload(errors) 序列化,而非直接 return new ApiResponse(...)
  • Rails + JSONAPI::Resources:抛 JSONAPI::Exceptions::InvalidResource 即可,它内部已实现 errors 方法,返回标准数组

关键区别在于:直接 return 字典会绕过序列化中间件,codestatus 字段可能被忽略或转成字符串。

本地调试时用 HTTPie 快速验证错误结构

别等前端联调才发现格式错——用这条命令秒测:

http POST :8000/api/users name=='' | jq '.errors[0].status, .errors[0].detail'

如果返回 null 或报 Cannot index array with string "errors",说明响应根本没走标准错误流程。这时要查两件事:

  • 是否所有异常都继承自框架的 base exception(如 JSONAPI::Exceptions::Error
  • 是否全局中间件/装饰器被某个路由 bypass 了(比如用了 @app.api_route 而非 @app.post

真正难的不是写错格式,而是让错误从 panic 瞬间变成可读、可定位、可归因的 ErrorObject —— 这需要每一层都守住边界,而不是靠最后一道 JSON 序列化兜底。

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

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

js json symfony

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2023.09.01

5530

6

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

3630

5

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

1808

5

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

2023.10.23

2295

4

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

2023.10.23

2832

6

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.03

2021

9

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.09

3077

8

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.13

2362

8

sprintf函数用法详解
sprintf函数用法详解

sprintf函数的用法:1、格式化字符串;2、指定输出宽度和精度;3、返回值。更多关于sprintf函数用法详解的内容,大家可以阅读下面的文章。

2023.11.27

10932

4

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Webman和FastAPI的性能对比
Webman和FastAPI的性能对比

共0课时 | 229人学习

FastAPI框架精讲课程
FastAPI框架精讲课程

共38课时 | 3.3万人学习

Symfony 官方文档
Symfony 官方文档

共0课时 | 0人学习