Laravel 5.5 API collections 的资源（独立数据）

Question

我想知道是否可以为项目资源和 collection 资源定义不同的数据。

对于 collection 我只想发送 ['id', 'title', 'slug'] 但项目资源将包含额外的详细信息 ['id', 'title', 'slug', 'user', etc.]

我想实现这样的目标：

class PageResource extends Resource
{
    /**
     * Transform the resource into an array.
     *
     * @param  \Illuminate\Http\Request
     * @return array
     */
    public function toArray($request)
    {
        return [
            'id' => $this->id,
            'title' => $this->title,
            'slug' => $this->slug,
            'user' => [
                'id' => $this->user->id,
                'name' => $this->user->name,
                'email' => $this->user->email,
            ],
        ];
    }
}

class PageResourceCollection extends ResourceCollection
{
    /**
     * Transform the resource collection into an array.
     *
     * @param  \Illuminate\Http\Request
     * @return array
     */
    public function toArray($request)
    {
        return [
            'id' => $this->id,
            'title' => $this->title,
            'slug' => $this->slug,
        ];
    }
}

PageResourceCollection 将无法按预期工作，因为它使用 PageResource 所以它需要

return [
            'data' => $this->collection,
       ];

我可以将资源复制到 PageFullResource / PageListResource 和 PageFullResourceCollection / PageListResourceCollection 中，但我正在尝试找到一种更好的方法来实现相同的结果。

Answer 1

资源 class 上有一个收集方法。您可以 return 将其作为 ResourceCollection 的参数输入，然后在该集合上指定您的转换。

控制器：

class PageController extends Controller
{
    public function index()
    {
        return new PageResourceCollection(PageResource::collection(Page::all()));
    }

    public function show(Page $page)
    {
        return new PageResource($page);
    }
}

资源：

class PageResource extends Resource
{
    public function toArray($request)
    {
        return [
            'id' => $this->id,
            'title' => $this->title,
            'slug' => $this->slug,
            'user' => [
                'id' => $this->user->id,
                'name' => $this->user->name,
                'email' => $this->user->email,
            ],
        ];
    }
}

class PageResourceCollection extends ResourceCollection
{
    public function toArray($request)
    {
        return [
            'data' => $this->collection->transform(function($page){
                return [
                    'id' => $page->id,
                    'title' => $page->title,
                    'slug' => $page->slug,
                ];
            }),
        ];
    }
}

Answer 2

如果您对使用链接和元数据不感兴趣，则接受的答案有效。如果需要，只需 return:

return new PageResourceCollection(Page::paginate(10));

在你的控制器中。在传递到资源集合之前，您还应该期待加载其他依赖关系。

Answer 3

如果希望Resource和Collection中的响应字段具有相同的值，可以在Collection中复用Resource

PersonResource.php

<?php

namespace App\Http\Resources;

use Illuminate\Http\Resources\Json\Resource;

class PersonResource extends Resource
{
    /**
     * Transform the resource into an array.
     *
     * @param  \Illuminate\Http\Request  $request
     * @return array
     */
    public function toArray($request)
    {
//        return parent::toArray($request);

        return [
            'id' => $this->id,
            'person_type' => $this->person_type,
            'first_name' => $this->first_name,
            'last_name' => $this->last_name,
            'created_at' => (string) $this->created_at,
            'updated_at' => (string) $this->updated_at,
        ];
    }
}

PersonCollection.php

<?php

namespace App\Http\Resources;

use Illuminate\Http\Resources\Json\ResourceCollection;

class PersonCollection extends ResourceCollection
{
    /**
     * Transform the resource collection into an array.
     *
     * @param  \Illuminate\Http\Request  $request
     * @return \Illuminate\Http\Resources\Json\AnonymousResourceCollection
     */
    public function toArray($request)
    {
//        return parent::toArray($request);
        return PersonResource::collection($this->collection);
    }
}

Laravel 5.5 API collections 的资源（独立数据）

Laravel 5.5 API resources for collections (standalone data)

php

laravel

eloquent

laravel-5.5

thephpleague-fractal