API Resources কী?

Question

API Resources কী?

Accepted Answer

**API Resources** হল ট্রান্সফরমেশন ক্লাস যা নিয়ন্ত্রণ করে কীভাবে Eloquent মডেল (এবং কালেকশন) **JSON-এ সিরিয়ালাইজ** করা হয় API রেসপন্সের জন্য। এগুলি আপনাকে API আউটপুট নির্ভুলভাবে আকার দিতে দেয় — কোন ফিল্ড এক্সপোজ করতে হবে তা নির্বাচন করা, সেগুলি পুনঃনাম করা, মান ফর্ম্যাট করা, এবং সম্পর্কিত ডেটা অন্তর্ভুক্ত করা — API উপস্থাপনা ডাটাবেস স্ট্রাকচার থেকে আলাদা করে।

## The problem: exposing 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, ... } 😱
```

## The solution: an 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
```

রিসোর্সের `toArray()` মেথড সঠিকভাবে JSON শেপ সংজ্ঞায়িত করে — আপনি নিয়ন্ত্রণ করেন কোন ফিল্ড প্রদর্শিত হয়, সেগুলি পুনঃনাম এবং ফর্ম্যাট করেন, এবং সম্পর্কিত রিসোর্স অন্তর্ভুক্ত করেন। সংবেদনশীল ফিল্ডগুলি সহজভাবে অন্তর্ভুক্ত করা হয় না।

## Conditional and nested 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
];
```

## কেন এটি গুরুত্বপূর্ণ

API Resources গুরুত্বপূর্ণ Laravel-এ সু-ডিজাইন করা, নিরাপদ API তৈরির জন্য — এগুলি আপনাকে JSON আউটপুটের উপর নির্ভুল নিয়ন্ত্রণ দেয়, যা **নিরাপত্তা** এবং API ডিজাইন উভয়ের জন্যই গুরুত্বপূর্ণ।

সবচেয়ে গুরুত্বপূর্ণ সুবিধা হল **ডেটা লিক প্রতিরোধ করা**: সরাসরি Eloquent মডেল রিটার্ন করা তাদের সমস্ত কলাম এক্সপোজ করে (সম্ভাব্যভাবে পাসওয়ার্ড হ্যাশ, অভ্যন্তরীণ ফ্ল্যাগ, বা অন্যান্য সংবেদনশীল ডেটা সহ — একটি গুরুতর দুর্বলতা), যেখানে API Resources আপনাকে স্পষ্টভাবে বেছে নিতে দেয় কোন ফিল্ড এক্সপোজ করতে হবে, নিশ্চিত করে যে সংবেদনশীল ডেটা কখনোই ক্লায়েন্টদের কাছে পৌঁছায় না।

নিরাপত্তার বাইরে, এগুলি সক্ষম করে পরিষ্কার API ডিজাইন **API উপস্থাপনা ডাটাবেস স্কীমা থেকে আলাদা করে** — আপনি ফিল্ড পুনঃনাম করতে পারেন, মান ফর্ম্যাট করতে পারেন (তারিখ, বুলিয়ান), নেস্টেড/সম্পর্কিত ডেটা স্ট্রাকচার করতে পারেন, এবং শর্তভিত্তিকভাবে পারমিশনের উপর ভিত্তি করে ফিল্ড অন্তর্ভুক্ত করতে পারেন, সবই একটি ডেডিকেটেড ট্রান্সফরমেশন ক্লাসে।

এটি API চুক্তিকে স্থিতিশীল এবং ইচ্ছাকৃত রাখে অভ্যন্তরীণ টেবিল স্ট্রাকচারের সাথে সংযুক্ত হওয়ার পরিবর্তে।

API Resources বোঝা — কীভাবে তারা JSON আউটপুট আকার দেয়, স্পষ্ট ফিল্ড নিয়ন্ত্রণের নিরাপত্তা সুবিধা, এবং শর্তাধীন ফিল্ড এবং নেস্টেড রিসোর্সের মতো বৈশিষ্ট্য — পেশাদার Laravel API তৈরির জন্য গুরুত্বপূর্ণ জ্ঞান, কারণ raw মডেল এক্সপোজ করা অনিরাপদ এবং খারাপ ডিজাইন উভয়ই।

REST/JSON API বর্তমানে Laravel-এর একটি প্রাথমিক ব্যবহার হিসাবে, এবং রেসপন্স শেপ নিয়ন্ত্রণ করা (নিরাপদে এবং পরিষ্কারভাবে) একটি সাধারণ, গুরুত্বপূর্ণ প্রয়োজন হিসাবে, API Resources একটি ঘনঘন-ব্যবহৃত, মূল্যবান টুল যা সু-নির্মিত, নিরাপদ API-কে ডেটা লিক করা বা আউটপুট ডাটাবেসের সাথে দৃঢ়ভাবে সংযুক্ত করা API থেকে আলাদা করে।