Класс контроллера происходит от класса 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, нам нужно настроить свойство 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' 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
- УДАЛИТЬ / users / 20 — удалить пользователя 20
- ОПЦИИ / пользователи — показать поддерживаемые глаголы относительно конечной точки / пользователей
- ОПЦИИ / users / 20 — показать поддерживаемые глаголы, касающиеся конечной точки / users / 20
GET / users — список всех пользователей страница за страницей
HEAD / users — показать обзорную информацию о списке пользователей
POST / users — создать нового пользователя
GET / users / 20 — вернуть данные пользователя 20
HEAD / users / 20 — показать обзорную информацию о пользователе 20
PATCH / users / 20 и PUT / users / 20 — обновить пользователя 20
УДАЛИТЬ / users / 20 — удалить пользователя 20
ОПЦИИ / пользователи — показать поддерживаемые глаголы относительно конечной точки / пользователей
ОПЦИИ / users / 20 — показать поддерживаемые глаголы, касающиеся конечной точки / users / 20
Обратите внимание, что Yii автоматически множит имя контроллера.
Шаг 3 — Теперь откройте Почтальон, введите http: // localhost: 8080 / users и нажмите «Отправить». Вы увидите следующее.
Шаг 4 — Чтобы создать нового пользователя, измените тип запроса на POST, добавьте два параметра тела: имя и адрес электронной почты и нажмите «Отправить».
Шаг 5 — Вы можете использовать параметр fields, чтобы указать, какие поля должны быть включены в результат. Например, URL http: // localhost: 8080 / users? Fields = id , name будет возвращать только поля id и name, как показано на следующем снимке экрана.