Laravel 5.5 中如何处理API接口返回的JSON响应格式【实战】

陌强大大_6942

陌强大大_6942

2026-06-29

1008人浏览

原创

真正卡住人的三处是中间件链、异常路径未拦截、模型序列化边界;api路由须定义在routes/api.php,状态码需显式传入response()->json(),所有异常必须经handler::render()统一处理,模型字段需正确配置可见性与格式。

laravel 5.5 中如何处理api接口返回的json响应格式【实战】

直接用 response()->json() 就能返回 JSON,但“统一格式”不是加个函数调用就完事——真正卡住人的,是中间件链、异常路径没拦截、模型序列化边界这三处。

API 路由必须走 routes/api.php,否则返回 HTML

Laravel 的 api 中间件组自带 EnsureFrontendRequestsAreStateful 和自动 JSON 协商能力。如果把 API 路由写在 routes/web.php 里,哪怕加了 ->middleware('api'),也可能被 session 或 CSRF 中间件劫持,最终返回 HTML 页面而非 JSON。

  • 确认路由定义在 routes/api.php 文件中(该文件默认已绑定 api 中间件组)
  • 手动测试时用 curl -H "Accept: application/json" http://localhost:8000/api/users,避免浏览器直输(不带 Accept 头)
  • 不要在 web.php 里混写 API 路由;若必须,得确保没被 web 中间件包裹(比如误写成 ->middleware('web'))

response()->json() 的第三个参数别漏:状态码要显式传

很多接口创建后仍返回 200,前端收不到 201,是因为忘了传状态码。REST 规范要求资源创建成功必须用 201,删除成功用 204(且不能带响应体)。

chartjs-reporter
chartjs-reporter

此技能用于在用户需要将结构化数据(查询结果、CSV 摘要、JSON 记录或 Python 字典/列表)转换为独立的 HTML 页面时使用。

下载
  • 创建成功:return response()->json(['data' => $user], 201);
  • 删除成功:return response()->json([], 204);(注意:空数组也不行,204 响应体必须为空)
  • 验证失败:return response()->json(['message' => 'Validation failed', 'errors' => $validator->errors()], 422);
  • 别把 json_encode() 结果再传给 response()->json(),会导致双重编码(如 "{\"user\":{...}}")

所有异常路径都得进 Handler::render(),否则格式崩了

控制器里写了统一结构,但 ModelNotFoundException、ValidationException、AuthenticationException 这些根本不会经过你的控制器——它们由 App\Exceptions\Handler 拦截。不重写 render(),前端就会收到 HTML 错误页或裸数组。

  • 在 app/Exceptions/Handler.php 的 render() 方法开头加判断:if ($request->expectsJson()) { ... }
  • 对 ModelNotFoundException,返回 response()->json(['message' => 'Not found'], 404),别用默认英文提示
  • 对 ValidationException,提取 $exception->errors(),包装成你定义的 code/message/data 结构
  • 对 AuthenticationException,可复写 unauthenticated() 方法,返回带 code 字段的 401 响应

模型转 JSON 前先确认字段可见性与时间格式

Eloquent 模型默认不输出 password、remember_token,但如果你用了 $appends 或自定义 toArray(),又没预加载关联关系,很容易触发 N+1 或字段缺失。

  • 检查 $hidden 和 $casts:比如 protected $casts = ['created_at' => 'datetime:Y-m-d H:i:s'];
  • 动态字段(如 is_subscribed)必须声明在 $appends 并提供 getIsSubscribedAttribute() 方法
  • 别在 ApiResource 的 toArray() 里写数据库查询;预加载应在控制器完成:User::with('posts')->findOrFail($id)
  • 分页响应要用 $users->toArray() 后手动补 meta 字段,JsonResource::collection() 不会自动带分页元信息

最常被跳过的其实是 Handler::render() 里的 $request->expectsJson() 判断——只要这里漏掉,任何异常都会退回到 HTML 或调试页面,前端 fetch 就静默失败。中间件、状态码、模型序列化,三者缺一不可。

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

相关文章

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

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

下载

相关标签:

laravel js json

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

相关专题

更多
laravel组件介绍
laravel组件介绍

laravel 提供了丰富的组件,包括身份验证、模板引擎、缓存、命令行工具、数据库交互、对象关系映射器、事件处理、文件操作、电子邮件发送、队列管理和数据验证。想了解更多laravel的相关内容,可以阅读本专题下面的文章。

2024.04.09

857

10

laravel中间件介绍
laravel中间件介绍

laravel 中间件分为五种类型:全局、路由、组、终止和自定。想了解更多laravel中间件的相关内容,可以阅读本专题下面的文章。

2024.04.09

835

9

laravel使用的设计模式有哪些
laravel使用的设计模式有哪些

laravel使用的设计模式有:1、单例模式;2、工厂方法模式;3、建造者模式;4、适配器模式;5、装饰器模式;6、策略模式;7、观察者模式。想了解更多laravel的相关内容,可以阅读本专题下面的文章。

2024.04.09

2488

10

thinkphp和laravel哪个简单
thinkphp和laravel哪个简单

对于初学者来说,laravel 的入门门槛较低,更易上手,原因包括:1. 更简单的安装和配置;2. 丰富的文档和社区支持;3. 简洁易懂的语法和 api;4. 平缓的学习曲线。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.04.10

4161

7

laravel入门教程
laravel入门教程

本专题整合了laravel入门教程,想了解更多详细内容,请阅读专题下面的文章。

2025.08.05

5990

22

laravel实战教程
laravel实战教程

本专题整合了laravel实战教程,阅读专题下面的文章了解更多详细内容。

2025.08.05

3976

13

laravel面试题
laravel面试题

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

2025.08.05

7449

7

PHP高性能API设计与Laravel服务架构实践
PHP高性能API设计与Laravel服务架构实践

本专题围绕 PHP 在现代 Web 后端开发中的高性能实践展开,重点讲解基于 Laravel 框架构建可扩展 API 服务的核心方法。内容涵盖路由与中间件机制、服务容器与依赖注入、接口版本管理、缓存策略设计以及队列异步处理方案。同时结合高并发场景,深入分析性能瓶颈定位与优化思路,帮助开发者构建稳定、高效、易维护的 PHP 后端服务体系。

2026.03.04

1436

29

Laravel 框架安装指南
Laravel 框架安装指南

本指南详解 Laravel 框架安装全流程,涵盖 PHP 8.1+ 环境配置、Composer 依赖管理工具安装及国内镜像源优化。重点演示使用 composer create-project 命令创建 Laravel 10/11 项目,解决常见安装错误与依赖冲突。从环境搭建到项目初始化,助您快速完成 Laravel 开发环境部署,为后续 Web 应用开发奠定基础。适合 PHP 初学者与框架迁移开发者参考。

2026.04.09

215

6

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
如何安装 Composer
如何安装 Composer

共1课时 | 208人学习

Composer手册
Composer手册

共0课时 | 0人学习