RESTful API এর ধারণা

RESTful API একটি আধুনিক ওয়েব অ্যাপ্লিকেশন ডিজাইন আর্কিটেকচার, যা ক্লায়েন্ট-সার্ভার কমিউনিকেশন মডেল ব্যবহার করে। এটি HTTP প্রটোকলকে ব্যবহার করে ডেটা আদান-প্রদান করে এবং বিভিন্ন ক্লায়েন্ট যেমন ব্রাউজার, মোবাইল অ্যাপ্লিকেশন বা অন্যান্য সার্ভিসের সাথে যোগাযোগ স্থাপন করে। Yii ফ্রেমওয়ার্কে RESTful API তৈরি করা খুবই সহজ এবং এর জন্য Yii একটি শক্তিশালী সমাধান প্রদান করে। Yii 2 এর মধ্যে yii\rest\Controller ক্লাসটি ব্যবহৃত হয়, যা RESTful API তৈরি করতে সহায়তা করে।

RESTful API কী?

REST (Representational State Transfer) একটি আর্কিটেকচারাল স্টাইল, যা ওয়েব সার্ভিসের জন্য HTTP প্রটোকল ব্যবহার করে। এটি ডিজাইন প্যাটার্ন হিসেবে সাধারণত ওয়েব অ্যাপ্লিকেশন এবং ওয়েব সার্ভিসের মধ্যে ক্লায়েন্ট-সার্ভার কমিউনিকেশনকে সহজ এবং কার্যকরী করে।

RESTful API-র মূল ধারণা হল:

• Stateless: প্রতিটি রিকোয়েস্ট সার্ভারের কাছে সম্পূর্ণ তথ্য সহ পাঠাতে হয়। সার্ভার রিকোয়েস্টের মধ্যে কোনো স্টেট সংরক্ষণ করে না।
• Resource-based: প্রতিটি রিসোর্স (যেমন ডেটাবেসের রেকর্ড) একটি নির্দিষ্ট URL দিয়ে অ্যাক্সেস করা হয়।
• HTTP Methods: RESTful API সাধারণত HTTP মেথড (GET, POST, PUT, DELETE) ব্যবহার করে রিসোর্সের সাথে ইন্টারঅ্যাক্ট করে।
  • GET: রিসোর্স থেকে ডেটা আনা।
  • POST: নতুন রিসোর্স তৈরি করা।
  • PUT: বিদ্যমান রিসোর্স আপডেট করা।
  • DELETE: রিসোর্স মুছে ফেলা।

Yii তে RESTful API তৈরি

Yii ফ্রেমওয়ার্কে RESTful API তৈরি করার জন্য বিশেষ ক্লাস এবং কনফিগারেশন পদ্ধতি রয়েছে। Yii 2 তে REST API তৈরি করতে নিম্নলিখিত পদক্ষেপগুলো অনুসরণ করা যায়:

১. RESTful Controller তৈরি করা

Yii তে RESTful API তৈরি করার জন্য আপনাকে একটি কাস্টম কন্ট্রোলার তৈরি করতে হবে, যা yii\rest\ActiveController বা yii\rest\Controller এক্সটেন্ড করবে। ActiveController সাধারণত ডাটাবেসের সাথে ইন্টারঅ্যাক্ট করার জন্য ব্যবহৃত হয়, যেখানে Controller ক্লাসটি আরও কাস্টম লজিকের জন্য ব্যবহৃত হয়।

উদাহরণ: PostController তৈরি করা

namespace app\controllers;

use yii\rest\ActiveController;

class PostController extends ActiveController
{
    public $modelClass = 'app\models\Post'; // রিসোর্সের মডেল ক্লাস
}

এখানে PostController ক্লাসটি yii\rest\ActiveController এক্সটেন্ড করছে এবং এটি Post মডেল ক্লাসের সাথে কাজ করবে। ActiveController স্বয়ংক্রিয়ভাবে বিভিন্ন HTTP মেথড যেমন GET, POST, PUT, DELETE এর জন্য প্রয়োজনীয় অ্যাকশনগুলো তৈরি করে।

২. রাউটিং কনফিগারেশন

Yii-তে RESTful API রাউটিং করার জন্য আপনাকে urlManager কম্পোনেন্টে কিছু কনফিগারেশন করতে হবে। রেস্টফুল API-র জন্য বিশেষ patterns এবং rules নির্ধারণ করা হয়।

উদাহরণ: urlManager কনফিগারেশন

'components' => [
    'urlManager' => [
        'enablePrettyUrl' => true,  // প্রিটী URL এনাবল করা
        'showScriptName' => false,  // script name (index.php) hidden করা
        'rules' => [
            'POST api/posts' => 'post/create',  // POST রিকোয়েস্টের জন্য রুল
            'GET api/posts' => 'post/index',    // GET রিকোয়েস্টের জন্য রুল
            'PUT api/posts/<id:\d+>' => 'post/update',  // PUT রিকোয়েস্টের জন্য রুল
            'DELETE api/posts/<id:\d+>' => 'post/delete', // DELETE রিকোয়েস্টের জন্য রুল
        ],
    ],
],

এখানে POST, GET, PUT, এবং DELETE রিকোয়েস্টের জন্য নির্দিষ্ট রাউটিং রুল নির্ধারণ করা হয়েছে, যা PostController ক্লাসের মধ্যে ম্যাপ হবে।

৩. Authentication (অথেনটিকেশন)

RESTful API-র জন্য অথেনটিকেশন খুবই গুরুত্বপূর্ণ। Yii তে সাধারণত Token-based authentication ব্যবহার করা হয়। এটি নিশ্চিত করে যে ক্লায়েন্ট শুধুমাত্র একটি বৈধ টোকেন সরবরাহ করলে API অ্যাক্সেস করতে পারবে।

উদাহরণ: Token Authentication

Yii-তে Token-based authentication সেটআপ করতে yii\filters\auth\HttpBearerAuth ফিল্টার ব্যবহার করা হয়।

namespace app\controllers;

use yii\rest\ActiveController;
use yii\filters\auth\HttpBearerAuth;

class PostController extends ActiveController
{
    public $modelClass = 'app\models\Post';

    public function behaviors()
    {
        $behaviors = parent::behaviors();
        $behaviors['authenticator'] = [
            'class' => HttpBearerAuth::class,
        ];
        return $behaviors;
    }
}

এখানে HttpBearerAuth ক্লাসটি API রিকোয়েস্টের মধ্যে Bearer Token যাচাই করবে। ক্লায়েন্টকে API কল করার সময় এই টোকেনটি প্রদান করতে হবে।

৪. JSON রেসপন্স ফরম্যাট

RESTful API সাধারণত JSON ফরম্যাটে ডেটা পাঠায় এবং গ্রহণ করে। Yii ফ্রেমওয়ার্কে ডিফল্টভাবে API রেসপন্স JSON ফরম্যাটে থাকে। তবে আপনি কাস্টম রেসপন্সও তৈরি করতে পারেন।

উদাহরণ: কাস্টম রেসপন্স

namespace app\controllers;

use yii\rest\ActiveController;
use yii\web\Response;

class PostController extends ActiveController
{
    public $modelClass = 'app\models\Post';

    public function behaviors()
    {
        $behaviors = parent::behaviors();
        $behaviors['contentNegotiator'] = [
            'class' => \yii\filters\ContentNegotiator::class,
            'formats' => [
                'application/json' => Response::FORMAT_JSON, // JSON ফরম্যাট
            ],
        ];
        return $behaviors;
    }
}

এখানে contentNegotiator ফিল্টারটি JSON ফরম্যাটে রেসপন্স নিশ্চিত করছে।

৫. Error Handling (ত্রুটি ব্যবস্থাপনা)

Yii তে RESTful API ত্রুটির ক্ষেত্রে স্বয়ংক্রিয়ভাবে HTTP status code এবং ত্রুটির বার্তা ফেরত দেয়। তবে আপনি কাস্টম ত্রুটি বার্তা এবং কাস্টম স্ট্যাটাস কোডও ব্যবহার করতে পারেন।

উদাহরণ: কাস্টম ত্রুটি বার্তা

use yii\web\NotFoundHttpException;

public function actionView($id)
{
    $post = Post::findOne($id);
    if (!$post) {
        throw new NotFoundHttpException("The requested post does not exist.");
    }
    return $post;
}

এখানে NotFoundHttpException ব্যবহার করা হয়েছে, যা 404 স্ট্যাটাস কোড এবং কাস্টম বার্তা প্রদান করবে যদি নির্দিষ্ট পোস্ট না পাওয়া যায়।

সারাংশ

Yii ফ্রেমওয়ার্কে RESTful API তৈরি করা খুবই সহজ এবং নমনীয়। এটি আপনাকে HTTP methods (GET, POST, PUT, DELETE) ব্যবহার করে ক্লায়েন্ট এবং সার্ভারের মধ্যে ডেটা আদান-প্রদান করতে সহায়তা করে। Yii-তে yii\rest\ActiveController এবং yii\rest\Controller ব্যবহার করে API রাউটিং, অথেনটিকেশন, JSON রেসপন্স, এবং ত্রুটি ব্যবস্থাপনা সহজভাবে ইমপ্লিমেন্ট করা যায়। RESTful API তৈরিতে Yii একটি শক্তিশালী সমাধান প্রদান করে, যা আধুনিক ওয়েব অ্যাপ্লিকেশনে কার্যকরভাবে ব্যবহৃত হতে পারে।