Laravel 中文文档

主题

Eloquent：API 资源 ​

简介 ​

构建 API 时，你可能需要一个位于 Eloquent 模型和实际返回给应用程序用户的 JSON 响应之间的转换层。例如，你可能希望为部分用户显示某些属性而不为其他用户显示，或者你可能希望始终在模型的 JSON 表示中包含某些关联。Eloquent 的资源类允许你以富有表现力且简便的方式将模型和模型集合转换为 JSON。

当然，你始终可以使用 toJson 方法将 Eloquent 模型或集合转换为 JSON；但是，Eloquent 资源提供了对模型及其关联的 JSON 序列化更细粒度和更强大的控制。

生成资源 ​

要生成资源类，可以使用 make:resource Artisan 命令。默认情况下，资源将放置在应用程序的 app/Http/Resources 目录中。资源继承 Illuminate\Http\Resources\Json\JsonResource 类：

shell
php artisan make:resource UserResource

资源集合 ​

除了生成转换单个模型的资源外，你还可以生成负责转换模型集合的资源。这允许你的 JSON 响应包含与给定资源的整个集合相关的链接和其他元信息。

要创建资源集合，你应该在创建资源时使用 --collection 标志。或者，在资源名称中包含 Collection 一词将向 Laravel 表明它应该创建一个集合资源。集合资源继承 Illuminate\Http\Resources\Json\ResourceCollection 类：

shell
php artisan make:resource User --collection

php artisan make:resource UserCollection

概念概述 ​

NOTE

这是对资源和资源集合的高级概述。强烈建议你阅读本文档的其他部分，以更深入地了解资源为你提供的自定义功能和强大能力。

在深入了解编写资源时可用的所有选项之前，让我们先从高层次了解资源在 Laravel 中的使用方式。资源类表示需要转换为 JSON 结构的单个模型。例如，这是一个简单的 UserResource 资源类：

php
<?php

namespace App\Http\Resources;

use Illuminate\Http\Request;
use Illuminate\Http\Resources\Json\JsonResource;

class UserResource extends JsonResource
{
    /**
     * 将资源转换为数组。
     *
     * @return array<string, mixed>
     */
    public function toArray(Request $request): array
    {
        return [
            'id' => $this->id,
            'name' => $this->name,
            'email' => $this->email,
            'created_at' => $this->created_at,
            'updated_at' => $this->updated_at,
        ];
    }
}

每个资源类都定义了一个 toArray 方法，该方法返回在资源作为路由或控制器方法的响应返回时应转换为 JSON 的属性数组。

请注意，我们可以直接从 $this 变量访问模型属性。这是因为资源类会自动将属性和方法访问代理到底层模型，以便于访问。一旦资源被定义，它就可以从路由或控制器返回。资源通过其构造函数接受底层模型实例：

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

Route::get('/user/{id}', function (string $id) {
    return new UserResource(User::findOrFail($id));
});

为方便起见，你可以使用模型的 toResource 方法，它将使用框架约定自动发现模型的底层资源：

php
return User::findOrFail($id)->toResource();

调用 toResource 方法时，Laravel 将尝试在最接近模型命名空间的 Http\Resources 命名空间中查找与模型名称匹配且可选地以 Resource 为后缀的资源。

如果你的资源类不遵循此命名约定或位于不同的命名空间中，你可以使用 UseResource 属性指定模型的默认资源：

php
<?php

namespace App\Models;

use App\Http\Resources\CustomUserResource;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Attributes\UseResource;

#[UseResource(CustomUserResource::class)]
class User extends Model
{
    // ...
}

或者，你可以通过将资源类传递给 toResource 方法来指定资源类：

php
return User::findOrFail($id)->toResource(CustomUserResource::class);

资源集合 ​

如果你要返回资源集合或分页响应，应该在路由或控制器中创建资源实例时使用资源类提供的 collection 方法：

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

Route::get('/users', function () {
    return UserResource::collection(User::all());
});

或者，为方便起见，你可以使用 Eloquent 集合的 toResourceCollection 方法，它将使用框架约定自动发现模型的底层资源集合：

php
return User::all()->toResourceCollection();

调用 toResourceCollection 方法时，Laravel 将尝试在最接近模型命名空间的 Http\Resources 命名空间中查找与模型名称匹配且以 Collection 为后缀的资源集合。

如果你的资源集合类不遵循此命名约定或位于不同的命名空间中，你可以使用 UseResourceCollection 属性指定模型的默认资源集合：

php
<?php

namespace App\Models;

use App\Http\Resources\CustomUserCollection;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Attributes\UseResourceCollection;

#[UseResourceCollection(CustomUserCollection::class)]
class User extends Model
{
    // ...
}

或者，你可以通过将资源集合类传递给 toResourceCollection 方法来指定：

php
return User::all()->toResourceCollection(CustomUserCollection::class);

自定义资源集合 ​

默认情况下，资源集合不允许添加可能需要与集合一起返回的自定义元数据。如果你想自定义资源集合响应，可以创建一个专门的资源来表示该集合：

shell
php artisan make:resource UserCollection

生成资源集合类后，你可以轻松定义应包含在响应中的任何元数据：

php
<?php

namespace App\Http\Resources;

use Illuminate\Http\Request;
use Illuminate\Http\Resources\Json\ResourceCollection;

class UserCollection extends ResourceCollection
{
    /**
     * 将资源集合转换为数组。
     *
     * @return array<int|string, mixed>
     */
    public function toArray(Request $request): array
    {
        return [
            'data' => $this->collection,
            'links' => [
                'self' => 'link-value',
            ],
        ];
    }
}

定义资源集合后，可以从路由或控制器返回它：

php
use App\Http\Resources\UserCollection;
use App\Models\User;

Route::get('/users', function () {
    return new UserCollection(User::all());
});

或者，为方便起见，你可以使用 Eloquent 集合的 toResourceCollection 方法，它将使用框架约定自动发现模型的底层资源集合：

php
return User::all()->toResourceCollection();

调用 toResourceCollection 方法时，Laravel 将尝试在最接近模型命名空间的 Http\Resources 命名空间中查找与模型名称匹配且以 Collection 为后缀的资源集合。

保留集合键 ​

从路由返回资源集合时，Laravel 会重置集合的键，使它们按数字顺序排列。但是，你可以在资源类上使用 PreserveKeys 属性来指示是否应保留集合的原始键：

php
<?php

namespace App\Http\Resources;

use Illuminate\Http\Resources\Attributes\PreserveKeys;
use Illuminate\Http\Resources\Json\JsonResource;

#[PreserveKeys]
class UserResource extends JsonResource
{
    // ...
}

当 preserveKeys 属性设置为 true 时，从路由或控制器返回集合时将保留集合键：

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

Route::get('/users', function () {
    return UserResource::collection(User::all()->keyBy->id);
});

自定义底层资源类 ​

通常，资源集合的 $this->collection 属性会自动填充为将集合中的每个项映射到其单数资源类的结果。单数资源类被假定为集合的类名去掉尾部的 Collection 部分。此外，根据你的个人偏好，单数资源类可能带有也可能不带有 Resource 后缀。

例如，UserCollection 将尝试将给定的用户实例映射到 UserResource 资源。要自定义此行为，你可以在资源集合上使用 Collects 属性：

php
<?php

namespace App\Http\Resources;

use Illuminate\Http\Resources\Attributes\Collects;
use Illuminate\Http\Resources\Json\ResourceCollection;

#[Collects(Member::class)]
class UserCollection extends ResourceCollection
{
    // ...
}

编写资源 ​

NOTE

如果你还没有阅读概念概述，强烈建议你在继续阅读本文档之前先阅读它。

资源只需要将给定的模型转换为数组。因此，每个资源都包含一个 toArray 方法，该方法将模型的属性转换为可以从应用程序的路由或控制器返回的 API 友好数组：

php
<?php

namespace App\Http\Resources;

use Illuminate\Http\Request;
use Illuminate\Http\Resources\Json\JsonResource;

class UserResource extends JsonResource
{
    /**
     * 将资源转换为数组。
     *
     * @return array<string, mixed>
     */
    public function toArray(Request $request): array
    {
        return [
            'id' => $this->id,
            'name' => $this->name,
            'email' => $this->email,
            'created_at' => $this->created_at,
            'updated_at' => $this->updated_at,
        ];
    }
}

定义资源后，可以直接从路由或控制器返回它：

php
use App\Models\User;

Route::get('/user/{id}', function (string $id) {
    return User::findOrFail($id)->toUserResource();
});

关联 ​

如果你想在响应中包含关联资源，可以将它们添加到资源的 toArray 方法返回的数组中。在此示例中，我们将使用 PostResource 资源的 collection 方法将用户的博客文章添加到资源响应中：

php
use App\Http\Resources\PostResource;
use Illuminate\Http\Request;

/**
 * 将资源转换为数组。
 *
 * @return array<string, mixed>
 */
public function toArray(Request $request): array
{
    return [
        'id' => $this->id,
        'name' => $this->name,
        'email' => $this->email,
        'posts' => PostResource::collection($this->posts),
        'created_at' => $this->created_at,
        'updated_at' => $this->updated_at,
    ];
}

NOTE

如果你只想在关联已经被加载时才包含它们，请查看条件关联的文档。

资源集合 ​

资源将单个模型转换为数组，而资源集合将模型集合转换为数组。但是，并不是绝对需要为每个模型定义资源集合类，因为所有 Eloquent 模型集合都提供了 toResourceCollection 方法来即时生成「临时」资源集合：

php
use App\Models\User;

Route::get('/users', function () {
    return User::all()->toResourceCollection();
});

但是，如果你需要自定义与集合一起返回的元数据，则需要定义自己的资源集合：

php
<?php

namespace App\Http\Resources;

use Illuminate\Http\Request;
use Illuminate\Http\Resources\Json\ResourceCollection;

class UserCollection extends ResourceCollection
{
    /**
     * 将资源集合转换为数组。
     *
     * @return array<string, mixed>
     */
    public function toArray(Request $request): array
    {
        return [
            'data' => $this->collection,
            'links' => [
                'self' => 'link-value',
            ],
        ];
    }
}

与单数资源一样，资源集合可以直接从路由或控制器返回：

php
use App\Http\Resources\UserCollection;
use App\Models\User;

Route::get('/users', function () {
    return new UserCollection(User::all());
});

或者，为方便起见，你可以使用 Eloquent 集合的 toResourceCollection 方法，它将使用框架约定自动发现模型的底层资源集合：

php
return User::all()->toResourceCollection();

调用 toResourceCollection 方法时，Laravel 将尝试在最接近模型命名空间的 Http\Resources 命名空间中查找与模型名称匹配且以 Collection 为后缀的资源集合。

数据包装 ​

默认情况下，当资源响应被转换为 JSON 时，最外层的资源会被包装在 data 键中。例如，典型的资源集合响应如下所示：

json
{
    "data": [
        {
            "id": 1,
            "name": "Eladio Schroeder Sr.",
            "email": "therese28@example.com"
        },
        {
            "id": 2,
            "name": "Liliana Mayert",
            "email": "evandervort@example.com"
        }
    ]
}

如果你想禁用最外层资源的包装，应该在基础 Illuminate\Http\Resources\Json\JsonResource 类上调用 withoutWrapping 方法。通常，你应该从 AppServiceProvider 或另一个在每次请求中加载的服务提供者中调用此方法：

php
<?php

namespace App\Providers;

use Illuminate\Http\Resources\Json\JsonResource;
use Illuminate\Support\ServiceProvider;

class AppServiceProvider extends ServiceProvider
{
    /**
     * 注册任何应用服务。
     */
    public function register(): void
    {
        // ...
    }

    /**
     * 引导任何应用服务。
     */
    public function boot(): void
    {
        JsonResource::withoutWrapping();
    }
}

WARNING

withoutWrapping 方法仅影响最外层响应，不会移除你手动添加到自己的资源集合中的 data 键。

包装嵌套资源 ​

你可以完全自由地决定如何包装资源的关联。如果你希望所有资源集合都包装在 data 键中（无论其嵌套层级如何），你应该为每个资源定义一个资源集合类并在 data 键中返回集合。

你可能会想知道这是否会导致最外层资源被包装在两个 data 键中。别担心，Laravel 永远不会让你的资源被意外地双重包装，所以你不必担心正在转换的资源集合的嵌套层级：

php
<?php

namespace App\Http\Resources;

use Illuminate\Http\Resources\Json\ResourceCollection;

class CommentsCollection extends ResourceCollection
{
    /**
     * 将资源集合转换为数组。
     *
     * @return array<string, mixed>
     */
    public function toArray(Request $request): array
    {
        return ['data' => $this->collection];
    }
}

数据包装与分页 ​

通过资源响应返回分页集合时，即使已经调用了 withoutWrapping 方法，Laravel 也会将资源数据包装在 data 键中。这是因为分页响应始终包含有关分页器状态信息的 meta 和 links 键：

json
{
    "data": [
        {
            "id": 1,
            "name": "Eladio Schroeder Sr.",
            "email": "therese28@example.com"
        },
        {
            "id": 2,
            "name": "Liliana Mayert",
            "email": "evandervort@example.com"
        }
    ],
    "links":{
        "first": "http://example.com/users?page=1",
        "last": "http://example.com/users?page=1",
        "prev": null,
        "next": null
    },
    "meta":{
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "http://example.com/users",
        "per_page": 15,
        "to": 10,
        "total": 10
    }
}

分页 ​

你可以将 Laravel 分页器实例传递给资源的 collection 方法或自定义资源集合：

php
use App\Http\Resources\UserCollection;
use App\Models\User;

Route::get('/users', function () {
    return new UserCollection(User::paginate());
});

或者，为方便起见，你可以使用分页器的 toResourceCollection 方法，它将使用框架约定自动发现分页模型的底层资源集合：

php
return User::paginate()->toResourceCollection();

分页响应始终包含有关分页器状态信息的 meta 和 links 键：

json
{
    "data": [
        {
            "id": 1,
            "name": "Eladio Schroeder Sr.",
            "email": "therese28@example.com"
        },
        {
            "id": 2,
            "name": "Liliana Mayert",
            "email": "evandervort@example.com"
        }
    ],
    "links":{
        "first": "http://example.com/users?page=1",
        "last": "http://example.com/users?page=1",
        "prev": null,
        "next": null
    },
    "meta":{
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "http://example.com/users",
        "per_page": 15,
        "to": 10,
        "total": 10
    }
}

自定义分页信息 ​

如果你想自定义分页响应中 links 或 meta 键中包含的信息，可以在资源上定义 paginationInformation 方法。该方法将接收 $paginated 数据和 $default 信息数组，该数组包含 links 和 meta 键：

php
/**
 * 自定义资源的分页信息。
 *
 * @param  \Illuminate\Http\Request  $request
 * @param  array  $paginated
 * @param  array  $default
 * @return array
 */
public function paginationInformation($request, $paginated, $default)
{
    $default['links']['custom'] = 'https://example.com';

    return $default;
}

条件属性 ​

有时你可能希望仅在满足给定条件时才在资源响应中包含某个属性。例如，你可能希望仅在当前用户是「管理员」时才包含某个值。Laravel 提供了多种辅助方法来帮助你处理这种情况。when 方法可用于有条件地向资源响应添加属性：

php
/**
 * 将资源转换为数组。
 *
 * @return array<string, mixed>
 */
public function toArray(Request $request): array
{
    return [
        'id' => $this->id,
        'name' => $this->name,
        'email' => $this->email,
        'secret' => $this->when($request->user()->isAdmin(), 'secret-value'),
        'created_at' => $this->created_at,
        'updated_at' => $this->updated_at,
    ];
}

在此示例中，secret 键只会在已认证用户的 isAdmin 方法返回 true 时才会在最终资源响应中返回。如果该方法返回 false，secret 键将在发送给客户端之前从资源响应中移除。when 方法允许你在构建数组时以富有表现力的方式定义资源，而无需使用条件语句。

when 方法还接受闭包作为其第二个参数，允许你仅在给定条件为 true 时才计算结果值：

php
'secret' => $this->when($request->user()->isAdmin(), function () {
    return 'secret-value';
}),

whenHas 方法可用于在底层模型上实际存在某个属性时包含它：

php
'name' => $this->whenHas('name'),

此外，whenNotNull 方法可用于在属性不为 null 时将其包含在资源响应中：

php
'name' => $this->whenNotNull($this->name),

合并条件属性 ​

有时你可能有多个属性应该基于相同条件才包含在资源响应中。在这种情况下，你可以使用 mergeWhen 方法仅在给定条件为 true 时将属性包含在响应中：

php
/**
 * 将资源转换为数组。
 *
 * @return array<string, mixed>
 */
public function toArray(Request $request): array
{
    return [
        'id' => $this->id,
        'name' => $this->name,
        'email' => $this->email,
        $this->mergeWhen($request->user()->isAdmin(), [
            'first-secret' => 'value',
            'second-secret' => 'value',
        ]),
        'created_at' => $this->created_at,
        'updated_at' => $this->updated_at,
    ];
}

同样，如果给定条件为 false，这些属性将在发送给客户端之前从资源响应中移除。

WARNING

mergeWhen 方法不应在混合使用字符串键和数字键的数组中使用。此外，它不应在数字键未按顺序排列的数组中使用。

条件关联 ​

除了有条件地加载属性外，你还可以根据关联是否已在模型上加载来有条件地在资源响应中包含关联。这允许你的控制器决定应在模型上加载哪些关联，而你的资源可以轻松地仅在它们实际已加载时才包含它们。最终，这使得在资源中更容易避免「N+1」查询问题。

whenLoaded 方法可用于有条件地加载关联。为了避免不必要地加载关联，此方法接受关联名称而不是关联本身：

php
use App\Http\Resources\PostResource;

/**
 * 将资源转换为数组。
 *
 * @return array<string, mixed>
 */
public function toArray(Request $request): array
{
    return [
        'id' => $this->id,
        'name' => $this->name,
        'email' => $this->email,
        'posts' => PostResource::collection($this->whenLoaded('posts')),
        'created_at' => $this->created_at,
        'updated_at' => $this->updated_at,
    ];
}

在此示例中，如果关联尚未加载，posts 键将在发送给客户端之前从资源响应中移除。

条件关联计数 ​

除了有条件地包含关联外，你还可以根据关联的计数是否已在模型上加载来有条件地在资源响应中包含关联「计数」：

php
new UserResource($user->loadCount('posts'));

whenCounted 方法可用于有条件地在资源响应中包含关联的计数。如果关联的计数不存在，此方法会避免不必要地包含该属性：

php
/**
 * 将资源转换为数组。
 *
 * @return array<string, mixed>
 */
public function toArray(Request $request): array
{
    return [
        'id' => $this->id,
        'name' => $this->name,
        'email' => $this->email,
        'posts_count' => $this->whenCounted('posts'),
        'created_at' => $this->created_at,
        'updated_at' => $this->updated_at,
    ];
}

在此示例中，如果 posts 关联的计数尚未加载，posts_count 键将在发送给客户端之前从资源响应中移除。

其他类型的聚合（如 avg、sum、min 和 max）也可以使用 whenAggregated 方法有条件地加载：

php
'words_avg' => $this->whenAggregated('posts', 'words', 'avg'),
'words_sum' => $this->whenAggregated('posts', 'words', 'sum'),
'words_min' => $this->whenAggregated('posts', 'words', 'min'),
'words_max' => $this->whenAggregated('posts', 'words', 'max'),

条件中间表信息 ​

除了在资源响应中有条件地包含关联信息外，你还可以使用 whenPivotLoaded 方法有条件地包含多对多关联的中间表数据。whenPivotLoaded 方法接受中间表名称作为第一个参数。第二个参数应该是一个闭包，返回当模型上有中间表信息可用时要返回的值：

php
/**
 * 将资源转换为数组。
 *
 * @return array<string, mixed>
 */
public function toArray(Request $request): array
{
    return [
        'id' => $this->id,
        'name' => $this->name,
        'expires_at' => $this->whenPivotLoaded('role_user', function () {
            return $this->pivot->expires_at;
        }),
    ];
}

如果你的关联使用了自定义中间表模型，你可以将中间表模型的实例作为第一个参数传递给 whenPivotLoaded 方法：

php
'expires_at' => $this->whenPivotLoaded(new Membership, function () {
    return $this->pivot->expires_at;
}),

如果你的中间表使用的访问器不是 pivot，你可以使用 whenPivotLoadedAs 方法：

php
/**
 * 将资源转换为数组。
 *
 * @return array<string, mixed>
 */
public function toArray(Request $request): array
{
    return [
        'id' => $this->id,
        'name' => $this->name,
        'expires_at' => $this->whenPivotLoadedAs('subscription', 'role_user', function () {
            return $this->subscription->expires_at;
        }),
    ];
}

添加元数据 ​

一些 JSON API 标准要求在资源和资源集合响应中添加元数据。这通常包括指向资源或相关资源的 links，或有关资源本身的元数据。如果你需要返回有关资源的额外元数据，请将其包含在 toArray 方法中。例如，你可以在转换资源集合时包含 links 信息：

php
/**
 * 将资源转换为数组。
 *
 * @return array<string, mixed>
 */
public function toArray(Request $request): array
{
    return [
        'data' => $this->collection,
        'links' => [
            'self' => 'link-value',
        ],
    ];
}

从资源返回额外的元数据时，你不必担心会意外覆盖 Laravel 在返回分页响应时自动添加的 links 或 meta 键。你定义的任何额外 links 都将与分页器提供的链接合并。

顶级元数据 ​

有时你可能希望仅在资源是返回的最外层资源时才在资源响应中包含某些元数据。通常，这包括有关整个响应的元信息。要定义此元数据，请在资源类中添加 with 方法。该方法应返回一个元数据数组，仅在资源是正在转换的最外层资源时才包含在资源响应中：

php
<?php

namespace App\Http\Resources;

use Illuminate\Http\Resources\Json\ResourceCollection;

class UserCollection extends ResourceCollection
{
    /**
     * 将资源集合转换为数组。
     *
     * @return array<string, mixed>
     */
    public function toArray(Request $request): array
    {
        return parent::toArray($request);
    }

    /**
     * 获取应与资源数组一起返回的额外数据。
     *
     * @return array<string, mixed>
     */
    public function with(Request $request): array
    {
        return [
            'meta' => [
                'key' => 'value',
            ],
        ];
    }
}

构造资源时添加元数据 ​

你还可以在路由或控制器中构造资源实例时添加顶级数据。additional 方法在所有资源上可用，接受一个应添加到资源响应中的数据数组：

php
return User::all()
    ->load('roles')
    ->toResourceCollection()
    ->additional(['meta' => [
        'key' => 'value',
    ]]);

JSON:API 资源 ​

Laravel 附带了 JsonApiResource，这是一个生成符合 JSON:API 规范响应的资源类。它继承了标准的 JsonResource 类，并自动处理资源对象结构、关联、稀疏字段集、包含，以及将 Content-Type 头设置为 application/vnd.api+json。

NOTE

Laravel 的 JSON:API 资源处理响应的序列化。如果你还需要解析传入的 JSON:API 查询参数（如过滤器和排序），Spatie 的 Laravel Query Builder 是一个很好的配套包。

生成 JSON:API 资源 ​

要生成 JSON:API 资源，请使用带有 --json-api 标志的 make:resource Artisan 命令：

shell
php artisan make:resource PostResource --json-api

生成的类将继承 Illuminate\Http\Resources\JsonApi\JsonApiResource 并包含供你定义的 $attributes 和 $relationships 属性：

php
<?php

namespace App\Http\Resources;

use Illuminate\Http\Request;
use Illuminate\Http\Resources\JsonApi\JsonApiResource;

class PostResource extends JsonApiResource
{
    /**
     * 资源的属性。
     */
    public $attributes = [
        // ...
    ];

    /**
     * 资源的关联。
     */
    public $relationships = [
        // ...
    ];
}

JSON:API 资源可以像标准资源一样从路由和控制器返回：

php
use App\Http\Resources\PostResource;
use App\Models\Post;

Route::get('/api/posts/{post}', function (Post $post) {
    return new PostResource($post);
});

或者，为方便起见，你可以使用模型的 toResource 方法：

php
Route::get('/api/posts/{post}', function (Post $post) {
    return $post->toResource();
});

这将生成一个符合 JSON:API 规范的响应：

json
{
    "data": {
        "id": "1",
        "type": "posts",
        "attributes": {
            "title": "Hello World",
            "body": "This is my first post."
        }
    }
}

要返回 JSON:API 资源集合，请使用 collection 方法或 toResourceCollection 便捷方法：

php
return PostResource::collection(Post::all());

return Post::all()->toResourceCollection();

定义属性 ​

有两种方式可以定义 JSON:API 资源中包含哪些属性。

最简单的方法是在资源上定义 $attributes 属性。你可以将属性名称列为值，这些值将直接从底层模型读取：

php
public $attributes = [
    'title',
    'body',
    'created_at',
];

或者，要完全控制资源的属性，你可以重写资源上的 toAttributes 方法：

php
/**
 * 获取资源的属性。
 *
 * @return array<string, mixed>
 */
public function toAttributes(Request $request): array
{
    return [
        'title' => $this->title,
        'body' => $this->body,
        'is_published' => $this->published_at !== null,
        'created_at' => $this->created_at,
        'updated_at' => $this->updated_at,
    ];
}

定义关联 ​

JSON:API 资源支持定义遵循 JSON:API 规范的关联。关联仅在客户端通过 include 查询参数请求时才会被序列化。

$relationships 属性 ​

你可以通过资源上的 $relationships 属性定义资源可包含的关联：

php
public $relationships = [
    'author',
    'comments',
];

当将关联名称列为值时，Laravel 将解析对应的 Eloquent 关联并自动发现适当的资源类。如果你需要显式指定资源类，可以将关联定义为键/类对：

php
use App\Http\Resources\UserResource;

public $relationships = [
    'author' => UserResource::class,
    'comments',
];

或者，你可以重写资源上的 toRelationships 方法：

php
/**
 * 获取资源的关联。
 */
public function toRelationships(Request $request): array
{
    return [
        'author' => UserResource::class,
        'comments',
    ];
}

包含关联 ​

客户端可以使用 include 查询参数请求关联资源：

GET /api/posts/1?include=author,comments

这将生成一个响应，其中 relationships 键包含资源标识符对象，顶级 included 数组包含完整的资源对象：

json
{
    "data": {
        "id": "1",
        "type": "posts",
        "attributes": {
            "title": "Hello World"
        },
        "relationships": {
            "author": {
                "data": {
                    "id": "1",
                    "type": "users"
                }
            },
            "comments": {
                "data": [
                    {
                        "id": "1",
                        "type": "comments"
                    }
                ]
            }
        }
    },
    "included": [
        {
            "id": "1",
            "type": "users",
            "attributes": {
                "name": "Taylor Otwell"
            }
        },
        {
            "id": "1",
            "type": "comments",
            "attributes": {
                "body": "Great post!"
            }
        }
    ]
}

可以使用点表示法包含嵌套关联：

GET /api/posts/1?include=comments.author

关联深度 ​

默认情况下，嵌套关联包含被限制为最大深度。你可以使用 maxRelationshipDepth 方法自定义此限制，通常在应用程序的某个服务提供者中设置：

php
use Illuminate\Http\Resources\JsonApi\JsonApiResource;

JsonApiResource::maxRelationshipDepth(3);

资源类型和 ID ​

默认情况下，资源的 type 从资源类名派生。例如，PostResource 生成类型 posts，BlogPostResource 生成 blog-posts。资源的 id 从模型的主键解析。

如果你需要自定义这些值，可以重写资源上的 toType 和 toId 方法：

php
/**
 * 获取资源的类型。
 */
public function toType(Request $request): string
{
    return 'articles';
}

/**
 * 获取资源的 ID。
 */
public function toId(Request $request): string
{
    return (string) $this->uuid;
}

当资源的类型应与其类名不同时（例如，当 AuthorResource 包装 User 模型并应输出类型 authors 时），这特别有用。

稀疏字段集和包含 ​

JSON:API 资源支持稀疏字段集，允许客户端使用 fields 查询参数仅请求每种资源类型的特定属性：

GET /api/posts?fields[posts]=title,created_at&fields[users]=name

这将仅包含 posts 资源的 title 和 created_at 属性，以及 users 资源的 name 属性。

忽略查询字符串 ​

如果你想为给定的资源响应禁用稀疏字段集过滤，可以调用 ignoreFieldsAndIncludesInQueryString 方法：

php
return $post->toResource()
    ->ignoreFieldsAndIncludesInQueryString();

包含先前加载的关联 ​

默认情况下，关联仅在通过 include 查询参数请求时才包含在响应中。如果你想包含所有先前预加载的关联（不管查询字符串如何），可以调用 includePreviouslyLoadedRelationships 方法：

php
return $post->load('author', 'comments')
    ->toResource()
    ->includePreviouslyLoadedRelationships();

你可以通过重写资源上的 toLinks 和 toMeta 方法向 JSON:API 资源对象添加链接和元信息：

php
/**
 * 获取资源的链接。
 */
public function toLinks(Request $request): array
{
    return [
        'self' => route('api.posts.show', $this->resource),
    ];
}

/**
 * 获取资源的元信息。
 */
public function toMeta(Request $request): array
{
    return [
        'readable_created_at' => $this->created_at->diffForHumans(),
    ];
}

这将在响应中的资源对象中添加 links 和 meta 键：

json
{
    "data": {
        "id": "1",
        "type": "posts",
        "attributes": {
            "title": "Hello World"
        },
        "links": {
            "self": "https://example.com/api/posts/1"
        },
        "meta": {
            "readable_created_at": "2 hours ago"
        }
    }
}

资源响应 ​

如你所读到的，资源可以直接从路由和控制器返回：

php
use App\Models\User;

Route::get('/user/{id}', function (string $id) {
    return User::findOrFail($id)->toResource();
});

但是，有时你可能需要在将传出的 HTTP 响应发送给客户端之前对其进行自定义。有两种方法可以实现这一点。首先，你可以在资源上链式调用 response 方法。此方法将返回一个 Illuminate\Http\JsonResponse 实例，让你完全控制响应的头信息：

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

Route::get('/user', function () {
    return User::find(1)
        ->toResource()
        ->response()
        ->header('X-Value', 'True');
});

或者，你可以在资源本身中定义 withResponse 方法。当资源作为响应中的最外层资源返回时，将调用此方法：

php
<?php

namespace App\Http\Resources;

use Illuminate\Http\JsonResponse;
use Illuminate\Http\Request;
use Illuminate\Http\Resources\Json\JsonResource;

class UserResource extends JsonResource
{
    /**
     * 将资源转换为数组。
     *
     * @return array<string, mixed>
     */
    public function toArray(Request $request): array
    {
        return [
            'id' => $this->id,
        ];
    }

    /**
     * 自定义资源的传出响应。
     */
    public function withResponse(Request $request, JsonResponse $response): void
    {
        $response->header('X-Value', 'True');
    }
}