Ресурсы API Laravel 5.5 для коллекций (автономные данные)
Мне было интересно, если можно определить разные данные для ресурса элемента и ресурса коллекции.
Для коллекции я хочу только отправить ['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 но я пытаюсь найти лучший способ достичь того же результата.
Решение
Класс Resource имеет метод коллекции. Вы можете вернуть его в качестве входного параметра для вашей коллекции 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,
];
}),
];
}
}
Другие решения
Принятый ответ работает, если вы не заинтересованы в использовании ссылок и метаданных. Если хотите, просто верните:
return new PageResourceCollection(Page::paginate(10));
в вашем контроллере. Вы также должны попытаться загрузить другие зависимые отношения, прежде чем переходить к коллекции ресурсов.
Если вы хотите, чтобы поля ответа имели одинаковое значение в Ресурсе и Коллекции, вы можете повторно использовать Ресурс внутри Коллекции
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);
}
}