Laravel接口怎么返回统一格式的JSON

千婷酱_7748

千婷酱_7748

2026-10-28

201人浏览

原创

Laravel API 统一 JSON 格式需三步:1. 创建 ApiController 封装 success/error 方法;2. 重写 Handler.php 的 render() 统一异常响应;3. 使用 API Resource 和 routes/api.php 确保请求走 API 通道。

laravel接口怎么返回统一格式的json

Laravel 接口返回统一格式的 JSON,核心不是“怎么输出 JSON”,而是“怎么让所有路径——无论成功、验证失败、404 还是 500——都返回结构一致、状态码准确、字段可控的 JSON”。只在控制器里写 response()->json(['data' => $user]) 是远远不够的,前端很快会遇到 message 在根级、data 有时缺失、错误时返回 HTML 或裸数组等问题。

用基类控制器封装 success/error 方法

新建 app/Http/Controllers/ApiController.php,继承默认 Controller,在里面定义标准化响应方法:

  • success($data, $message = 'OK', $code = 200):固定返回 ['code' => 0, 'message' => ..., 'data' => ...] 结构(code 建议业务约定,如 0 表示成功)
  • error($message, $code = 1001, $data = [], $httpStatus = 400):统一错误结构,$httpStatus 控制 HTTP 状态码(如 422 用于验证失败)
  • 所有 API 控制器继承它,比如 UserController extends ApiController,直接调用 $this->success($user) 即可

必须重写异常处理器 render() 方法

这是最容易被跳过的一步。不改这里,404、ValidationException、QueryException 全都会跳出你定义的格式。打开 app/Exceptions/Handler.php,修改 render():

arcgis-js
arcgis-js

提供 ArcGIS Maps SDK for JavaScript 开发辅助,涵盖 2D/3D 地图视图、图层管理、数据可视化、空间分析等功能模块的参考和示例指导。

下载
  • 先判断是否为 API 请求:if ($request->expectsJson()) { ... }
  • ModelNotFoundException → 返回 ['code' => 404, 'message' => '资源不存在', 'data' => []],状态码 404
  • ValidationException → 提取 $exception->errors(),返回 code: 422 + 统一结构,状态码 422
  • 其他未捕获异常(如 500)→ 生产环境只返回 ['code' => 500, 'message' => '服务异常'],不暴露堆栈

配合 API Resource 控制数据结构

避免在控制器里手动 ->toArray() 漏字段或暴露敏感信息。运行:

  • php artisan make:resource UserResource
  • 在 toArray() 中只定义要返回的字段,支持 whenLoaded()、when() 等条件逻辑
  • 控制器中返回 new UserResource($user) 或 UserResource::collection($users)
  • 如需去掉外层 "data":{...} 包裹,可在资源类中加 JsonResource::withoutWrapping();

确保请求走的是 API 路由通道

统一格式的前提是 Laravel 能识别这是 API 请求:

  • 所有接口路由必须注册在 routes/api.php(它自带 api 中间件组,含 JSON 协商能力)
  • 测试时用 curl -H "Accept: application/json" http://...,别直接在浏览器访问(浏览器默认发 text/html)
  • 不要把 Route::middleware('api') 加在 web.php 上——它不会触发 Laravel 的 API 响应逻辑

相关文章

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

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

下载

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

相关专题

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

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

2024.04.09

877

10

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

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

2024.04.09

855

9

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

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

2024.04.09

2508

10

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

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

2024.04.10

4501

7

laravel入门教程
laravel入门教程

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

2025.08.05

6570

22

laravel实战教程
laravel实战教程

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

2025.08.05

4316

13

laravel面试题
laravel面试题

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

2025.08.05

8109

7

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

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

2026.03.04

1496

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课时 | 215人学习

Composer手册
Composer手册

共0课时 | 0人学习