0

0

Laravel API资源(Resource)怎么格式化JSON输出

冰火之心

冰火之心

发布时间:2025-11-12 17:07:55

|

687人浏览过

|

来源于php中文网

原创

答案:Laravel API资源用于将模型转换为结构化JSON响应,通过自定义Resource类控制输出字段,如UserResource定义id、name、email等,支持条件字段(如when判断权限)、集合处理(collection方法)及元数据附加(additional或with方法),提升API数据一致性与可维护性。

laravel api资源(resource)怎么格式化json输出

在 Laravel 中,API 资源(Resource)用于将模型和模型集合转换为结构清晰、统一格式的 JSON 响应。通过自定义资源类,你可以精确控制返回给前端的 JSON 数据结构。

使用 API Resource 格式化输出

Laravel 提供了 ApiResource 类来封装模型数据。当你需要返回用户信息时,可以创建一个 UserResource 来定义输出字段。

php artisan make:resource UserResource

生成的资源类会包含一个 toArray 方法,用于定义 JSON 输出:

app/Http/Resources/UserResource.php

public function toArray($request)
{
    return [
        'id' => $this->id,
        'name' => $this->name,
        'email' => $this->email,
        'created_at' => $this->created_at->toISOString(),
    ];
}

在控制器中使用:

use App\Http\Resources\UserResource;
use App\Models\User;

return new UserResource(User::find(1));

处理资源集合

当返回多个模型时,使用 collection 或资源集合类:

阿里云AI平台
阿里云AI平台

阿里云AI平台

下载

  • 直接使用资源的 collection 方法:
  • return UserResource::collection(User::all());
  • 或创建独立的集合资源:
  • php artisan make:resource UserCollection

添加条件字段

某些字段可能只在特定条件下返回,比如管理员才能看到邮箱

use Illuminate\Http\Resources\MissingValue;

'email' => $this->when(auth()->user()?->isAdmin(), $this->email),

when 方法会在第一个参数为 true 时包含该字段,否则自动排除。

附加元数据(Meta Data)

你可以在资源响应中添加分页信息或自定义元数据:

return (new UserResource($user))
    ->additional([
        'meta' => [
            'timestamp' => now(),
            'version' => '1.0'
        ]
    ]);

也可以在资源类中重写 with 方法统一添加:

public function with($request)
{
    return [
        'success' => true,
    ];
}

基本上就这些。通过合理使用 Laravel 的 API 资源机制,你能轻松实现结构一致、可维护性强的 JSON 输出。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

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

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

340

2024.04.09

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

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

293

2024.04.09

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

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

773

2024.04.09

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

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

385

2024.04.10

laravel入门教程
laravel入门教程

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

141

2025.08.05

laravel实战教程
laravel实战教程

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

85

2025.08.05

laravel面试题
laravel面试题

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

80

2025.08.05

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

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

571

2026.03.04

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

26

2026.03.13

热门下载

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

精品课程

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

共137课时 | 13.5万人学习

JavaScript ES5基础线上课程教学
JavaScript ES5基础线上课程教学

共6课时 | 11.3万人学习

PHP新手语法线上课程教学
PHP新手语法线上课程教学

共13课时 | 1.0万人学习

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

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