0

0

laravel API资源(Resource)如何格式化JSON输出_Laravel API资源JSON格式化方法

穿越時空

穿越時空

发布时间:2025-10-08 13:27:02

|

175人浏览过

|

来源于php中文网

原创

laravel api资源类可将eloquent模型转为结构化json,通过userresource的toarray方法自定义字段命名、格式化日期、添加计算属性,并嵌套postresource处理关联数据,结合whenloaded和when方法实现按需加载与条件输出,提升api安全性与可维护性。

laravel api资源(resource)如何格式化json输出_laravel api资源json格式化方法

Laravel 的 API 资源(API Resources)提供了一种优雅的方式来将 Eloquent 模型转化为结构清晰的 JSON 响应。通过使用资源类,你可以精确控制返回给前端的数据格式,包括字段命名、嵌套关系、条件属性等。

创建 API 资源类

要格式化 JSON 输出,先为模型创建对应的资源类。例如,假设你有一个 User 模型:

php artisan make:resource UserResource

这会生成一个 UserResource 类,位于 app/Http/Resources 目录下。该类中包含一个 toArray 方法,用于定义输出字段:

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

格式化字段与自定义属性

toArray 方法中,你可以重命名字段、添加计算属性或格式化日期:

  • user_name 替代原始的 name 字段
  • 添加全名、头像 URL 等衍生数据
  • 使用 Carbon 格式化时间
return [
    'user_id' => $this->id,
    'user_name' => $this->name,
    'profile_image' => $this->avatar ? asset('storage/' . $this->avatar) : null,
    'full_name' => "{$this->first_name} {$this->last_name}",
    'registered_at' => $this->created_at->format('Y-m-d H:i:s'),
];

处理关联数据

当需要包含关联模型时,可以嵌套其他资源类。比如用户有多个文章:

Kacha
Kacha

KaCha是一款革命性的AI写真工具,用AI技术将照片变成杰作!

下载
use App\Http\Resources\PostResource;

return [
    'id' => $this->id,
    'name' => $this->name,
    'posts' => PostResource::collection($this->whenLoaded('posts')),
];

whenLoaded 方法确保只有在关系被预加载时才包含数据,避免 N+1 查询问题。

条件性字段输出

某些字段可能只对特定用户可见,可用 when 方法实现条件输出:

'reset_token' => $this->when($request->user()->isAdmin(), $this->reset_token),
'email_verified' => $this->when($this->email_verified_at, true),

这样可防止敏感信息泄露,同时保持响应结构整洁。

基本上就这些。合理使用 Laravel 资源类,能让 API 返回的 JSON 更规范、更安全,也更容易维护。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

通义千问
通义千问

阿里巴巴推出的全能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的相关内容,可以阅读本专题下面的文章。

772

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 后端服务体系。

463

2026.03.04

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

76

2026.03.11

热门下载

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

精品课程

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

共17课时 | 3.3万人学习

Bootstrap 5教程
Bootstrap 5教程

共46课时 | 3.6万人学习

Go语言实战之 GraphQL
Go语言实战之 GraphQL

共10课时 | 0.9万人学习

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

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