Yii - RESTful API 动作

  • 简述

    控制器类从yii\rest\ActiveController类扩展而来,它实现了常见的 RESTful 动作。我们指定$modelClass属性,以便控制器知道使用哪个模型来操作数据。
    第 1 步-在控制器文件夹中创建一个名为UserController.php的文件。
    
    <?php
       namespace app\controllers;
       use yii\rest\ActiveController;
       class UserController extends ActiveController {
          public $modelClass = 'app\models\MyUser';
       }
    ?>
    
    接下来我们需要设置 urlManager 组件,以便可以使用有意义的 HTTP 动词和漂亮的 URL 访问和操作用户数据。为了让 API 访问 JSON 格式的数据,我们应该配置请求应用程序组件的 parrs 属性。
    第 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;
    ?>
    
    通过最少的努力,我们刚刚构建了一个用于访问用户数据的 RESTful API。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 - 显示有关端点 /users 的支持动词
    • OPTIONS /users/20 - 显示有关端点 /users/ 20 的支持动词
    注意,Yii 自动将控制器名称复数。
    第 3 步- 现在,打开 Postman,输入http://localhost:8080/users,然后单击“发送”。您将看到以下内容。
    打开邮递员
    第 4 步- 要创建新用户,请将请求类型更改为 POST,添加两个正文参数:名称和电子邮件,然后单击“发送”。
    创建新用户
    第 5 步 - 您可以使用fields参数指定结果中应包含哪些字段。例如,URL http://localhost:8080/users?fields=id,name 将只返回idname字段,如下面的截图所示。
    使用字段