Recursos de API e respostas JSON

O que são recursos de API?

Gerando um recurso

$ php artisan make:resource UserResource
# For collections:
$ php artisan make:resource UserCollection

Recurso básico

<?php
namespace App\Http\Resources;

use Illuminate\Http\Resources\Json\JsonResource;

class UserResource extends JsonResource
{
    public function toArray($request): array
    {
        return [
            "id"         => $this->id,
            "name"       => $this->name,
            "email"      => $this->email,
            "created_at" => $this->created_at->toISOString(),
        ];
    }
}

Retornando um recurso

<?php
public function show(User $user): UserResource
{
    return new UserResource($user);
}
// Response: {"data": {"id": 1, "name": "Alice", ...}}

Coleções de recursos

<?php
public function index(): AnonymousResourceCollection
{
    return UserResource::collection(User::paginate(15));
}

Campos condicionais

<?php
return [
    "id"    => $this->id,
    "email" => $this->when($request->user()?->isAdmin(), $this->email),
    "token" => $this->whenLoaded("tokens", $this->tokens->first()->plainTextToken),
];

whenLoaded()

<?php
return [
    "id"      => $this->id,
    "posts"   => PostResource::collection($this->whenLoaded("posts")),
    "profile" => new ProfileResource($this->whenLoaded("profile")),
];

Recursos aninhados

<?php
return [
    "id"     => $this->id,
    "author" => new UserResource($this->author),
    "tags"   => TagResource::collection($this->tags),
];

Metadados adicionais

<?php
public function with($request): array
{
    return [
        "meta" => ["version" => "1.0"],
    ];
}

Empacotamento

<?php
// In AppServiceProvider::boot():
JsonResource::withoutWrapping();

Paginação em recursos

<?php
return UserResource::collection(User::paginate(15));
// Response includes: data[], links{}, meta{}

Testando recursos

<?php
$response->assertJsonStructure([
    "data" => ["id", "name", "email"]
]);

Resumo

Verificação rápida