Yii RESTful APIs实战
控制器类是扩展自 yii\rest\ActiveController 类,该类实现了常见的RESTful操作。我们指定 $modelClass 属性,以便控制器知道要使用哪个模型来操作数据。
步骤1 - 在controllers文件夹下创建一个名为 UserController.php 的文件。
<?php
namespace app\controllers;
use yii\rest\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
//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' environmentconfig['bootstrap'][] = 'debug';
config['modules']['debug'] = [
'class' => 'yii\debug\Module',
];config['bootstrap'][] = 'gii';
config['modules']['gii'] = [
'class' => 'yii\gii\Module',
];
}
returnconfig;
?>
以最小的努力,我们刚刚建立了一个用于访问用户数据的RESTful API。这些API包括 –
- GET /users - 按页列出所有用户
-
HEAD /users - 显示用户列表的总览信息
-
POST /users - 创建一个新用户
-
GET /users/20 - 返回用户20的详细信息
-
HEAD /users/20 - 显示用户20的总览信息
-
PATCH /users/20 and 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 只会返回 id 和 name 字段,如下所示的屏幕截图。