> ## Documentation Index
> Fetch the complete documentation index at: https://kawax.biz/llms.txt
> Use this file to discover all available pages before exploring further.

# Eloquent API Resource

> Come trasformare i modelli Eloquent in risposte JSON API coerenti. Dalla creazione delle classi resource ai campi condizionali fino all'integrazione con la paginazione.

## Cosa sono le API Resource

Quando costruisci un'API, restituire direttamente i modelli Eloquent come JSON può esporre colonne che vorresti nascondere o inviare al client molti dati che non gli servono.

Le **Eloquent API Resource** sono un livello di trasformazione tra il modello e la risposta JSON. Con il metodo `toArray()` definisci esplicitamente "cosa e in che formato" includere nella risposta.

```mermaid theme={null}
flowchart LR
  A["Modello Eloquent<br>(User)"] --> B["Classe resource<br>(UserResource)"]
  B --> C["Risposta JSON<br>{ id, name, email }"]
```

Vantaggi principali:

* Controllo totale sui campi inclusi nella risposta
* Un unico posto per rinominare campi e trasformare valori
* Puoi mostrare o nascondere campi in base a condizioni
* Puoi annidare le relazioni mantenendo una struttura coerente

## Creazione di una resource

Con il comando Artisan `make:resource` generi una classe resource.

```shell theme={null}
php artisan make:resource UserResource
```

La classe generata si trova nella directory `app/Http/Resources`.

```php theme={null}
<?php

namespace App\Http\Resources;

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

class UserResource extends JsonResource
{
    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,
        ];
    }
}
```

Con `$this` accedi direttamente alle proprietà del modello. La classe resource fa da proxy verso il modello.

## Uso nel controller

Puoi restituire la resource da controller o route.

```php theme={null}
use App\Http\Resources\UserResource;
use App\Models\User;

Route::get('/users/{user}', function (User $user) {
    return new UserResource($user);
});
```

In alternativa, usa il metodo `toResource()` del modello.

```php theme={null}
Route::get('/users/{user}', function (User $user) {
    return $user->toResource();
});
```

`toResource()` cerca automaticamente la classe resource corrispondente (`UserResource`) in base al nome del modello.

Di default la risposta è wrappata nella chiave `data`.

```json theme={null}
{
  "data": {
    "id": 1,
    "name": "Mario Rossi",
    "email": "mario@example.com",
    "created_at": "2024-01-15T10:00:00.000000Z",
    "updated_at": "2024-01-15T10:00:00.000000Z"
  }
}
```

## Resource collection

Per restituire più modelli usa il metodo `collection()`.

```php theme={null}
use App\Http\Resources\UserResource;
use App\Models\User;

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

Oppure `toResourceCollection()` su una collection Eloquent.

```php theme={null}
return User::all()->toResourceCollection();
```

### Resource collection personalizzata

Per aggiungere metadati all'intera collection crea una resource collection dedicata.

```shell theme={null}
php artisan make:resource UserCollection
```

```php theme={null}
<?php

namespace App\Http\Resources;

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

class UserCollection extends ResourceCollection
{
    public function toArray(Request $request): array
    {
        return [
            'data' => $this->collection,
            'links' => [
                'self' => route('users.index'),
            ],
        ];
    }
}
```

```php theme={null}
Route::get('/users', function () {
    return new UserCollection(User::all());
});
```

## Trasformazione dei campi

In `toArray()` puoi rinominare i campi e trasformare i valori.

```php theme={null}
public function toArray(Request $request): array
{
    return [
        'id' => $this->id,
        'full_name' => $this->name,                         // Rinomina il campo
        'email_address' => $this->email,                    // Rinomina il campo
        'role' => strtoupper($this->role),                  // Trasforma il valore
        'registered_at' => $this->created_at->toDateString(), // Formatta la data
    ];
}
```

## Campi condizionali

### when() — aggiungere campi in base a una condizione

Per includere un campo solo se una condizione è soddisfatta usa `when()`.

```php theme={null}
public function toArray(Request $request): array
{
    return [
        'id' => $this->id,
        'name' => $this->name,
        'email' => $this->email,
        // Incluso solo se l'utente autenticato è admin
        'secret_token' => $this->when(
            $request->user()?->isAdmin(),
            $this->secret_token
        ),
    ];
}
```

Se la condizione di `when()` è `false`, la chiave stessa viene rimossa dalla risposta.

### mergeWhen() — aggiungere più campi condizionalmente

Per gestire più campi con la stessa condizione usa `mergeWhen()`.

```php theme={null}
public function toArray(Request $request): array
{
    return [
        'id' => $this->id,
        'name' => $this->name,
        $this->mergeWhen($request->user()?->isAdmin(), [
            'admin_note' => $this->admin_note,
            'internal_id' => $this->internal_id,
        ]),
    ];
}
```

### whenLoaded() — includere solo relazioni già caricate

Includendo la relazione solo se è già stata caricata con eager loading eviti il problema N+1 e crei risposte flessibili.

```php theme={null}
use App\Http\Resources\PostResource;

public function toArray(Request $request): array
{
    return [
        'id' => $this->id,
        'name' => $this->name,
        'email' => $this->email,
        // Incluso solo se posts è stato caricato con with()
        'posts' => PostResource::collection($this->whenLoaded('posts')),
    ];
}
```

Nel controller decidi se caricare la relazione.

```php theme={null}
// Restituisce con i posts
return new UserResource($user->load('posts'));

// Restituisce senza posts
return new UserResource($user);
```

### whenCounted() — includere il conteggio condizionalmente

Include il conteggio di una relazione ottenuto con `loadCount()`.

```php theme={null}
public function toArray(Request $request): array
{
    return [
        'id' => $this->id,
        'name' => $this->name,
        'posts_count' => $this->whenCounted('posts'),
    ];
}
```

```php theme={null}
return new UserResource($user->loadCount('posts'));
```

## Resource annidate

Annidando una relazione con un'altra classe resource mantieni una struttura coerente.

```php theme={null}
// app/Http/Resources/PostResource.php
class PostResource extends JsonResource
{
    public function toArray(Request $request): array
    {
        return [
            'id' => $this->id,
            'title' => $this->title,
            'body' => $this->body,
            'author' => new UserResource($this->whenLoaded('user')),
            'comments' => CommentResource::collection($this->whenLoaded('comments')),
            'published_at' => $this->published_at?->toDateString(),
        ];
    }
}
```

```php theme={null}
// Controller
$post = Post::with(['user', 'comments'])->findOrFail($id);

return new PostResource($post);
```

```json theme={null}
{
  "data": {
    "id": 1,
    "title": "API Resource in Laravel",
    "author": {
      "id": 5,
      "name": "Mario Rossi",
      "email": "mario@example.com"
    },
    "comments": [
      { "id": 10, "body": "Molto utile!" }
    ]
  }
}
```

## Aggiungere metadati

### with() — metadati top-level

Per aggiungere metadati all'intera collection sovrascrivi il metodo `with()`.

```php theme={null}
class UserCollection extends ResourceCollection
{
    public function toArray(Request $request): array
    {
        return parent::toArray($request);
    }

    public function with(Request $request): array
    {
        return [
            'meta' => [
                'version' => '1.0',
                'generated_at' => now()->toIso8601String(),
            ],
        ];
    }
}
```

Esempio di risposta:

```json theme={null}
{
  "data": [...],
  "meta": {
    "version": "1.0",
    "generated_at": "2024-01-15T10:00:00+00:00"
  }
}
```

### additional() — aggiungere metadati dinamicamente

Se vuoi aggiungere metadati dinamicamente dal controller usa `additional()`.

```php theme={null}
return User::all()
    ->load('roles')
    ->toResourceCollection()
    ->additional(['meta' => [
        'total_admins' => User::where('role', 'admin')->count(),
    ]]);
```

## Combinazione con la paginazione

Passando un risultato paginato alla resource, `meta` e `links` vengono aggiunti automaticamente.

```php theme={null}
Route::get('/users', function () {
    return UserResource::collection(User::paginate(15));
});
```

Oppure:

```php theme={null}
return User::paginate(15)->toResourceCollection();
```

Esempio di risposta:

```json theme={null}
{
  "data": [
    { "id": 1, "name": "Mario Rossi" },
    { "id": 2, "name": "Giulia Bianchi" }
  ],
  "links": {
    "first": "https://example.com/users?page=1",
    "last": "https://example.com/users?page=5",
    "prev": null,
    "next": "https://example.com/users?page=2"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 5,
    "per_page": 15,
    "to": 15,
    "total": 72
  }
}
```

<Info>
  Nelle risposte paginate, anche se hai chiamato `withoutWrapping()`, la chiave `data` viene sempre inclusa per coesistere con le chiavi `meta` e `links` della paginazione.
</Info>

## Disabilitare il wrapping

Di default la resource più esterna viene wrappata nella chiave `data`. Per disabilitarlo chiama `withoutWrapping()` in `boot()` di `AppServiceProvider`.

```php theme={null}
use Illuminate\Http\Resources\Json\JsonResource;

public function boot(): void
{
    JsonResource::withoutWrapping();
}
```

<Warning>
  `withoutWrapping()` agisce solo sul wrapping più esterno. Le chiavi `data` che definisci tu non vengono rimosse.
</Warning>

## Esempio pratico: implementazione di un'API utenti

Progettazione di risposte coerenti tramite resource per un'API di gestione utenti.

```mermaid theme={null}
flowchart TD
  A["GET /api/users"] --> B["UserController@index"]
  C["GET /api/users/:id"] --> D["UserController@show"]
  B --> E["UserResource::collection(paginate)"]
  D --> F["new UserResource(user)"]
  E --> G["{ data: [...], meta, links }"]
  F --> H["{ data: { id, name, email, ... } }"]
```

### UserResource

```php theme={null}
<?php

namespace App\Http\Resources;

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

class UserResource extends JsonResource
{
    public function toArray(Request $request): array
    {
        return [
            'id' => $this->id,
            'name' => $this->name,
            'email' => $this->email,
            'avatar_url' => $this->avatar_url,
            'role' => $this->role,
            // Mostrato solo agli admin
            'created_at' => $this->when(
                $request->user()?->isAdmin(),
                $this->created_at->toDateString()
            ),
            // Incluso solo se caricato
            'posts' => PostResource::collection($this->whenLoaded('posts')),
            'posts_count' => $this->whenCounted('posts'),
        ];
    }
}
```

### UserController

```php theme={null}
<?php

namespace App\Http\Controllers\Api;

use App\Http\Resources\UserResource;
use App\Models\User;
use Illuminate\Http\Request;
use Illuminate\Http\Resources\Json\AnonymousResourceCollection;

class UserController extends Controller
{
    public function index(): AnonymousResourceCollection
    {
        $users = User::withCount('posts')->paginate(20);

        return UserResource::collection($users);
    }

    public function show(User $user): UserResource
    {
        $user->loadCount('posts')->load('posts');

        return new UserResource($user);
    }
}
```

## Pagine correlate

<Card title="Introduzione alle relazioni Eloquent" icon="link" href="/it/eloquent-relationships">
  Rivedi come definire le relazioni e l'eager loading.
</Card>

<Card title="Paginazione" icon="list" href="/it/pagination">
  Impara come combinare risultati paginati con le API resource.
</Card>


## Related topics

- [Serializzazione Eloquent](/it/eloquent-serialization.md)
- [Accessor, mutator e cast di Eloquent](/it/eloquent-mutators.md)
- [Frontend](/it/frontend.md)
- [Paginazione](/it/pagination.md)
- [Attributi PHP](/it/advanced/php-attributes.md)