Yii - API RESTful en action

La classe de contrôleur s'étend du yii\rest\ActiveControllerclass, qui implémente les actions RESTful courantes. Nous spécifions le$modelClass propriété afin que le contrôleur sache quel modèle utiliser pour manipuler les données.

Step 1 - Créez un fichier appelé UserController.php dans le dossier des contrôleurs.

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

Ensuite, nous devons configurer le composant urlManager, de sorte que les données utilisateur puissent être consultées et manipulées avec des verbes HTTP significatifs et de jolies URL. Pour permettre à l'API d'accéder aux données dans JSON, nous devons configurer la propriété parsers durequest composant d'application.

Step 2 - Modifier le config/web.php déposer de cette façon -

<?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;
?>

Avec un minimum d'efforts, nous venons de créer une API RESTful pour accéder aux données utilisateur. Les API incluent -

  • GET /users - lister tous les utilisateurs page par page

  • HEAD /users - afficher les informations générales de la liste des utilisateurs

  • POST /users - créer un nouvel utilisateur

  • GET /users/20 - renvoyer les coordonnées de l'utilisateur 20

  • HEAD /users/20 - afficher les informations générales de l'utilisateur 20

  • PATCH /users/ 20 and PUT /users/20 - mettre à jour l'utilisateur 20

  • DELETE /users/20 - supprimer l'utilisateur 20

  • OPTIONS /users - afficher les verbes pris en charge concernant les terminaux / utilisateurs

  • OPTIONS /users/20 - afficher les verbes pris en charge concernant endpoint / users / 20

Notez que Yii pluralise automatiquement le nom du contrôleur.

Step 3 - Maintenant, ouvrez Postman, entrez http://localhost:8080/users, et cliquez sur «Envoyer». Vous verrez ce qui suit.

Step 4 - Pour créer un nouvel utilisateur, changez le type de demande en POST, ajoutez deux paramètres de corps: nom et e-mail, puis cliquez sur «Envoyer».

Step 5 - Vous pouvez utiliser le fieldsparamètre pour spécifier les champs à inclure dans le résultat. Par exemple, l'URLhttp://localhost:8080/users?fields=id, le nom ne renverra que le id et name champs comme indiqué dans la capture d'écran suivante.