Yii - APIs RESTful em ação
A classe do controlador estende-se do yii\rest\ActiveControllerclasse, que implementa ações RESTful comuns. Nós especificamos o$modelClass propriedade para que o controlador saiba qual modelo usar para manipular os dados.
Step 1 - Crie um arquivo chamado UserController.php dentro da pasta de controladores.
<?php
namespace app\controllers;
use yii\rest\ActiveController;
class UserController extends ActiveController {
public $modelClass = 'app\models\MyUser';
}
?>
Em seguida, precisamos configurar o componente urlManager, para que os dados do usuário possam ser acessados e manipulados com verbos HTTP significativos e URLs bonitos. Para permitir que a API acesse os dados em JSON, devemos configurar a propriedade parsers dorequest componente do aplicativo.
Step 2 - Modifique o config/web.php arquivar desta forma -
<?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;
?>
Com o mínimo de esforço, acabamos de construir uma API RESTful para acessar os dados do usuário. As APIs incluem -
GET /users - lista todos os usuários página por página
HEAD /users - mostra as informações gerais da lista de usuários
POST /users - criar um novo usuário
GET /users/20 - devolver os detalhes do usuário 20
HEAD /users/20 - mostra as informações gerais do usuário 20
PATCH /users/ 20 and PUT /users/20 - atualize o usuário 20
DELETE /users/20 - exclua o usuário 20
OPTIONS /users - mostrar os verbos suportados em relação ao endpoint / usuários
OPTIONS /users/20 - mostrar os verbos suportados em relação ao endpoint / usuários / 20
Observe que o Yii pluraliza automaticamente o nome do controlador.
Step 3 - Agora, abra o Postman, aperte http://localhost:8080/userse clique em “Enviar”. Você verá o seguinte.
Step 4 - Para criar um novo usuário, altere o tipo de solicitação para POST, adicione dois parâmetros de corpo: nome e e-mail e clique em “Enviar”.
Step 5 - Você pode usar o fieldsparâmetro para especificar quais campos devem ser incluídos no resultado. Por exemplo, o URLhttp://localhost:8080/users?fields=id, o nome só retornará o id e name campos como mostrado na imagem a seguir.