Yii - RESTful API 实际应用
控制器类从 yii est\ActiveController 类扩展而来,该类实现了常见的 RESTful 操作。我们指定 $modelClass 属性,以便控制器知道使用哪个模型来操作数据。
步骤 1 − 在 controllers 文件夹中创建一个名为 UserController.php 的文件。
<?php namespace app\controllers; use yii est\ActiveController; class UserController extends ActiveController { public $modelClass = 'app\models\MyUser'; } ?>
接下来,我们需要设置 urlManager 组件,以便可以使用有意义的 HTTP 动词和漂亮的 URL 访问和操作用户数据。为了让 API 访问 JSON 中的数据,我们应该配置 request 应用程序组件的 parsers 属性。
步骤 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 //cookie 验证所需 'cookieValidationKey' => 'ymoaYrebZHa8gURuolioHGlK8fLXCKjO', ], 'cache' => [ 'class' => 'yii\caching\FileCache', ], 'user' => [ 'identityClass' => 'app\models\User', 'enableAutoLogin' => true, ], 'errorHandler' => [ 'errorAction' => 'site/error', ], 'mailer' => [ 'class' => 'yii\swiftmailer\Mailer', // 默认将所有邮件发送到一个文件。您必须设置 // 'useFileTransport' 为 false 并配置传输 // 以便邮件程序发送真实的电子邮件。 '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 est\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) { // 针对"dev"环境的配置调整 $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,添加两个正文参数:name 和 email,然后单击"发送"。
步骤 5 − 您可以使用 fields 参数指定结果中应包含哪些字段。例如,URL http://localhost:8080/users?fields=id, name 将仅返回 id 和 name 字段,如以下屏幕截图所示。