API Resources su nini?

Question

Accepted Answer

**API Resources** su azuzuwar classes da suke sarrafa yadda Eloquent models (da collections) ake **serialize zuwa JSON** don amsa API. Suna ba ka damar dashe wa API output sosai — zabar ayyuka da za ka fallaki, sake suna su, tsara ƙimomi, da haɗa ajiya daidaitattun data — kuma a kewaida ta yadda ake adana bayanan a cikin database.

## Matsala: fallaka raw models

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

## Maganin: 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
```

Resource `toArray()` tana bayyana daidai yadda JSON yake — kana sarrafa ayyuka da za su bayyana, sake su suna, tsara su, da haɗa alaka na resources. Ayyuka na asirta ba a haɗa su ba.

## Sharadi da ajiya ta ƙetare

```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
];
```

## Why it matters

API Resources yana mahimanci don gina lahani niyya, API masu kariya a Laravel — suna ba ka sarrafa fasali akan JSON output, wanda yana mahimanci don **kariya** da tsari na API.

Fasalin da ya fi mahimanci shi ne **hana tausayin bayani**: kunna Eloquent models kai tsaye ya fallaka duk su columns (wataƙila haɗa da asesswodi hashes, ciki flags, ko sauran bayani masu kariya — rashin kariya mai tsanani), saida API Resources suna ba ka damar zabar azuzuwar ayyuka da za ka fallaki, tabbatar da cewa bayani masu kariya bai kai wa clients ba.

Bayan kariya, suna haifar da tsartar API mai tsarki ta **kewaida ta wakilar API daga database schema** — kana iya sake sunawa ayyuka, tsara ƙimomi (lokaci, boolean), tsara ƙetare/alaka bayani, da sharadi haɗa ayyuka bisa izini, duka a cikin daidaitattun azuzuwar class.

Zan kula fushi na API a tattalin duraɗa da amfani maimakon haɗa zuwa table structure na ciki.

Gane API Resources — yadda suke tsara JSON output, fasalin kariya na sarrafa ayyuka baje-baje, da fasalai kamar sharadi ayyuka da ƙetare resources — yana mahimanci ilimin gina lahani niyya, Laravel APIs, saboda fallaka raw models ba kariyaje ba ne kawai kuma da yawa samu tsari, wanda yake fallaka data ko haɗa output su database.

A matsayin REST/JSON APIs sune babbar amfani na Laravel jiya, da kamar yadda sarrafa amsa shape (da kariya da tsarki) yana da mahimanci, akwai buɗe buɗe buɗe buɗe, mahimanci, API Resources yana karfe-karfe, mahimanci kayan aikin da ya bambanta lahani-gina, kariyatattun APIs daga wanda yake fallaka bayani ko haɗa output zuwa database.