Laravel环境部署API资源转换:Eloquent模型与JSON响应格式化【介绍】

千宇吖_1371

千宇吖_1371

2026-06-01

778人浏览

原创

laravel api 资源是为 eloquent 模型封装可控 json 输出规范的类,通过 toarray() 实现字段过滤、关系嵌套、格式转换与安全脱敏;使用 make:resource 生成单资源或集合资源,配合 whenloaded 避免 n+1,可继承自定义基类统一响应结构。

laravel环境部署api资源转换:eloquent模型与json响应格式化【介绍】

在 Laravel 中部署 API 资源(API Resources),本质是为 Eloquent 模型建立一层可控、可复用的 JSON 输出规范。它不是简单地调用 toJson(),而是通过类封装实现字段过滤、关系嵌套、格式转换和安全控制,让接口响应结构清晰、前后端职责分明。

生成资源类并定义基础结构

使用 Artisan 命令快速创建资源类,它会自动放在 app/Http/Resources 目录下,并继承 JsonResource:

  • php artisan make:resource UserResource → 处理单个模型
  • php artisan make:resource User --collection 或 php artisan make:resource UserCollection → 处理集合(如分页列表)

打开生成的 UserResource.php,重点修改 toArray() 方法。这里直接通过 $this 访问模型属性,例如:

laravel-specialist
laravel-specialist

精通 Laravel 10+,遵循现代 PHP 实践的 Laravel 专家。擅长优雅语法、Eloquent ORM、队列系统及企业级特性...

下载
return [
    'id' => $this->id,
    'name' => $this->name,
    'email' => $this->email,
    'created_at' => $this->created_at->toISOString(),
];

控制输出字段与敏感信息

资源类天然支持字段精简和脱敏,避免意外暴露密码、remember_token 等字段:

  • 不写进 toArray() 的字段就不会出现在 JSON 中
  • 可重命名字段(如用 user_id 替代 id)
  • 可添加计算属性(如 'full_name' => "{$this->first_name} {$this->last_name}")
  • 可结合模型访问器(getAvatarUrlAttribute)统一处理头像路径等逻辑

嵌套关联数据与按需加载

当需要包含关联模型(如用户的文章列表、所属角色)时,推荐在资源中嵌套其他资源类,并配合 Laravel 提供的条件方法避免 N+1 查询:

  • 用 $this->whenLoaded('posts', fn() => PostResource::collection($this->posts)) 实现“仅当已预加载时才输出”
  • 用 $this->when($this->is_admin, ['is_super_admin' => true]) 控制字段是否出现
  • 对集合资源(如 UserCollection),框架会自动识别 LengthAwarePaginator 并注入 links 和 meta 分页信息

统一响应格式与扩展能力

默认资源会把数据包在 data 键下,如需全局统一结构(如含 code、message、timestamp),可自定义基类:

  • 新建 app/Http/Resources/ApiResource.php,继承 JsonResource
  • 设置 public static $wrap = null 关闭默认外层包装
  • 重写 toArray(),合并业务数据与公共字段:array_merge(parent::toArray($request), ['code' => 200, 'message' => 'OK'])
  • 让所有业务资源(如 UserResource)继承该基类

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

相关文章

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

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

下载

相关标签:

laravel

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

相关专题

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

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

2023.09.01

11104

6

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

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

2023.10.11

6441

5

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

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

2023.10.11

2155

5

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

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

2023.10.23

4088

4

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

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

2023.10.23

4794

6

html怎么上传
html怎么上传

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

2023.11.03

3771

9

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

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

2023.11.09

5397

8

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

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

2023.11.13

4242

8

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

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

2023.11.27

12142

4

热门下载

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

精品课程

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

共1课时 | 209人学习

Composer手册
Composer手册

共0课时 | 0人学习