Laravel API资源（Resource）怎么格式化JSON输出

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

在 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 appHttpResourcesUserResource; use AppModelsUser;  return new UserResource(User::find(1));

处理资源集合

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

Find JSON Path Online

Easily find JSON paths within JSON objects using our intuitive Json Path Finder

30

查看详情

• 直接使用资源的 collection 方法：

return UserResource::collection(User::all());

• 或创建独立的集合资源：

php artisan make:resource UserCollection

添加条件字段

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

use IlluminateHttpResourcesMissingValue;  '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 输出。

以上就是 Laravel API 资源（Resource）怎么格式化 JSON 输出的详细内容，更多请关注 php 中文网其它相关文章！