نحوه استفاده از RESTful APIs به صورت عملی در فریمورک Yii

کلاسcontroller  ی که از کلاس yii\rest\ActiveController گسترش می یابد، action های معمول RESTful را پیاده سازی می کند. ما property با نام $modelClass را تعریف می کنیم تا controller بداند از کدام مدل برای اداره ی داده ها استفاده می شود.

مرحله 1 - یک فایل به نام UserController.php داخل پوشه controllers  ایجاد کنید.

<?php
   namespace app\controllers;
   use yii\rest\ActiveController;
   class UserController extends ActiveController {
      public $modelClass = 'app\models\MyUser';
   }
?>

بعد، ما باید کامپوننت urlManager را راه اندازی کنیم، به طوری که داده های کاربر را می توان با  HTTP و URLها مورد استفاده قرار داد. برای دسترسی به داده های API در JSON، باید پروپرتی parsers از کامپوننت برنامه request پیکربندی کنیم.

مرحله 2 - فایل config/web.php را اینگونه تغییر دهید.

<?php
   $params = require(__DIR__ . '/params.php');
   $config = [
      'id' => 'basic',
      'basePath' => dirname(__DIR__),
      'bootstrap' => ['log'],
      'components' => [
         'request' => [
            // !!! insert a secret key in the following (if it is empty) - this is 
               //required by cookie validation
            'cookieValidationKey' => 'ymoaYrebZHa8gURuolioHGlK8fLXCKjO',
         ],
         'cache' => [
            'class' => 'yii\caching\FileCache',
         ],
         'user' => [
            'identityClass' => 'app\models\User',
            'enableAutoLogin' => true,
         ],
         'errorHandler' => [
            'errorAction' => 'site/error',
         ],
         'mailer' => [
            'class' => 'yii\swiftmailer\Mailer',
            // send all mails to a file by default. You have to set
            // 'useFileTransport' to false and configure a transport
            // for the mailer to send real emails.
            'useFileTransport' => true,
         ],
         'log' => [
            'traceLevel' => YII_DEBUG ? 3 : 0,
            'targets' => [
               [
                  'class' => 'yii\log\FileTarget',
                  'levels' => ['error', 'warning'],
               ],
            ],
         ],
         'urlManager' => [
            'enablePrettyUrl' => true,
            'enableStrictParsing' => true,
            'showScriptName' => false,
            'rules' => [
               ['class' => 'yii\rest\UrlRule', 'controller' => 'user'],
            ],
         ],
         'request' => [
            'parsers' => [
               'application/json' => 'yii\web\JsonParser',
            ]
         ],
         'db' => require(__DIR__ . '/db.php'),
      ],
      'modules' => [
         'hello' => [
            'class' => 'app\modules\hello\Hello',
         ],
      ],
      'params' => $params,
   ];
   if (YII_ENV_DEV) {
      // configuration adjustments for 'dev' environment
      $config['bootstrap'][] = 'debug';
      $config['modules']['debug'] = [
         'class' => 'yii\debug\Module',
      ];
      $config['bootstrap'][] = 'gii';
      $config['modules']['gii'] = [
         'class' => 'yii\gii\Module',
      ];
   }
   return $config;
?>

با کمترین تلاش، ما یک API RESTful برای دسترسی به داده های کاربر ایجاد کردیم. API ها شامل :

GET / users - تمام کاربران را بر اساس صفحات لیست می کند

HEAD / users - اطلاعات کلی کاربران را به صورت لیست نشان می دهد

POST / users - یک کاربر جدید ایجاد می کند

GET / users / 20 - جزئیات  کاربر 20 را باز می گرداند

HEAD / users / 20 - اطلاعات کلی کاربر 20 را نمایش می دهد

PATCH / users / 20 و PUT / users / 20 - کاربر 20 را به روزرسانی می کند

DELETE / users / 20 - کاربر 20 را حذف می کند

OPTIONS / users - افعال پشتیبانی شده در مورد endpoint / users را نشان می دهد

OPTIONS / users / 20 - افعال پشتیبانی شده مربوط به endpoint / users / 20 را نشان می دهد

توجه کنید که فریمورک Yii به طور خودکار نام controller  را به صورت جمع در می آورد.

مرحله 3 - حال Postman را باز کنید، آدرس http://localhost:8080/users  را در آن وارد کنید و روی “Send” کلیک کنید. آنچه که مشاهده می کنید مطابق با تصویر زیر می باشد.

مرحله 4 - برای ایجاد یک کاربر جدید،  request type را به POST تغییر دهید و دو پارامتر body را به آن اضافه کنید:  name و  emailو بعد روی “Send” کلیک کنید.

مرحله 5 - شما می توانید به وسیله ی پارامترfields مشخص کنید کدام یک از field ها به عنوان نتیجه نمایش داده شوند. همانطور که در تصویر زیر مشاهده می کنید، آدرس http://localhost:8080/users?fields=id، فقط فیلدهای id و name را به عنوان نتیجه برمی گردانند.