Hvad er API Resources?

Question

Accepted Answer

**API Resources** er transformationsklasser, der styrer, hvordan Eloquent-modeller (og samlinger) **serialiseres til JSON** til API-svar. De lader dig forme API-output præcist — ved at vælge hvilke felter der skal eksponeres, omdøbe dem, formatere værdier og inkludere relaterede data — og frakoble API-repræsentationen fra databasestrukturen.

## Problemet: eksponering af rå modeller

```php
// ❌ returning a model directly exposes ALL columns (maybe including sensitive ones)
return User::find($id);   // { id, name, email, password_hash, internal_notes, ... } 😱
```

## Løsningen: en API Resource

```php
<?php
// php artisan make:resource UserResource
class UserResource extends JsonResource {
    public function toArray($request): array {
        return [
            'id' => $this->id,
            'name' => $this->name,
            'email' => $this->email,
            // password and internal fields deliberately OMITTED
            'joined' => $this->created_at->toDateString(),   // format a value
            'is_admin' => (bool) $this->is_admin,
            // include related data (conditionally loaded)
            'posts' => PostResource::collection($this->whenLoaded('posts')),
        ];
    }
}
```

```php
// use it in a controller
return new UserResource($user);                  // a single model
return UserResource::collection(User::all());     // a collection
```

Resourceens `toArray()` definerer præcist JSON-formen — du styrer hvilke felter der vises, omdøber og formaterer dem, og inkluderer relaterede ressourcer. Følsomme felter inkluderes simpelthen ikke.

## Betinget og indlejret data

```php
return [
    'id' => $this->id,
    'secret' => $this->when($request->user()->isAdmin(), $this->secret),  // conditional field
    'posts' => PostResource::collection($this->whenLoaded('posts')),       // only if eager-loaded
];
```

## Hvorfor det betyder noget

API Resources er vigtige for at bygge veldesignede, sikre API'er i Laravel — de giver dig præcis kontrol over JSON-output, som betyder noget både for **sikkerhed** og API-design.

Den mest kritiske fordel er **forhindring af dataleaks**: returnering af Eloquent-modeller direkte eksponerer alle deres kolonner (potentielt inkluderet password-hashes, interne flag eller andre følsomme data — en alvorlig sårbarhed), hvorimod API Resources lader dig eksplicit vælge hvilke felter der skal eksponeres, og sikrer at følsomme data aldrig når klienterne.

Ud over sikkerhed muliggør de rent API-design ved at **frakoble API-repræsentationen fra databaseskemaet** — du kan omdøbe felter, formatere værdier (datoer, booleske værdier), strukturere indlejret/relaterede data, og betinget inkludere felter baseret på tilladelser, alt i en dedikeret transformationsklasse.

Dette holder API-kontrakten stabil og intentionel i stedet for koblet til intern tabelstruktur.

Forståelse af API Resources — hvordan de former JSON-output, sikkerhedsfordelen ved eksplicit feltkontrol, og funktioner som betingede felter og indlejrede ressourcer — er vigtig viden for at bygge professionelle Laravel API'er, da eksponering af rå modeller både er usikker og dårligt design.

Som REST/JSON API'er er en primær brug af Laravel i dag, og da kontrol af responsform (sikkert og rent) er et almindeligt, vigtigt behov, er API Resources et hyppigt brugt, værdifuldt værktøj, der skelner velbyggede, sikre API'er fra dem, der lækker data eller tæt koblet deres output til databasen.