Yii - API RESTful en acción
La clase de controlador se extiende desde el yii\rest\ActiveControllerclass, que implementa acciones RESTful comunes. Especificamos el$modelClass propiedad para que el controlador sepa qué modelo usar para manipular datos.
Step 1 - Crea un archivo llamado UserController.php dentro de la carpeta de controladores.
<?php
namespace app\controllers;
use yii\rest\ActiveController;
class UserController extends ActiveController {
public $modelClass = 'app\models\MyUser';
}
?>
A continuación, debemos configurar el componente urlManager, de modo que se pueda acceder a los datos del usuario y manipularlos con verbos HTTP significativos y URL bonitas. Para permitir que la API acceda a los datos en JSON, debemos configurar la propiedad del analizadorrequest componente de la aplicación.
Step 2 - Modificar el config/web.php archivar de esta manera -
<?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;
?>
Con el mínimo esfuerzo, acabamos de crear una API RESTful para acceder a los datos del usuario. Las API incluyen:
GET /users - enumerar todos los usuarios página por página
HEAD /users - mostrar la información general de la lista de usuarios
POST /users - crear un nuevo usuario
GET /users/20 - devolver los datos del usuario 20
HEAD /users/20 - mostrar la información general del usuario 20
PATCH /users/ 20 and PUT /users/20 - actualizar el usuario 20
DELETE /users/20 - eliminar el usuario 20
OPTIONS /users - mostrar los verbos admitidos en relación con el punto final / usuarios
OPTIONS /users/20 - mostrar los verbos compatibles con respecto a endpoint / users / 20
Tenga en cuenta que Yii pluraliza automáticamente el nombre del controlador.
Step 3 - Ahora, abre Postman, ingresa http://localhost:8080/usersy haga clic en "Enviar". Verá lo siguiente.
Step 4 - Para crear un nuevo usuario, cambie el tipo de solicitud a POST, agregue dos parámetros de cuerpo: nombre y correo electrónico, y haga clic en "Enviar".
Step 5 - Puedes usar el fieldsparámetro para especificar qué campos deben incluirse en el resultado. Por ejemplo, la URLhttp://localhost:8080/users?fields=id, el nombre solo devolverá el id y name campos como se muestra en la siguiente captura de pantalla.