Yii - API RESTful in azione
La classe controller si estende da yii\rest\ActiveControllerclass, che implementa azioni RESTful comuni. Specifichiamo il$modelClass in modo che il controller sappia quale modello utilizzare per manipolare i dati.
Step 1 - Crea un file chiamato UserController.php all'interno della cartella controller.
<?php
namespace app\controllers;
use yii\rest\ActiveController;
class UserController extends ActiveController {
public $modelClass = 'app\models\MyUser';
}
?>
Successivamente dobbiamo configurare il componente urlManager, in modo che i dati dell'utente possano essere consultati e manipolati con verbi HTTP significativi e URL graziosi. Per consentire all'API di accedere ai dati in JSON, è necessario configurare la proprietà parser direquest componente dell'applicazione.
Step 2 - Modifica il file config/web.php archiviare in questo modo -
<?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 il minimo sforzo, abbiamo appena creato un'API RESTful per l'accesso ai dati degli utenti. Le API includono:
GET /users - elenca tutti gli utenti pagina per pagina
HEAD /users - mostra le informazioni generali dell'elenco degli utenti
POST /users - crea un nuovo utente
GET /users/20 - restituire i dati dell'utente 20
HEAD /users/20 - mostra le informazioni generali dell'utente 20
PATCH /users/ 20 and PUT /users/20 - aggiornare l'utente 20
DELETE /users/20 - eliminare l'utente 20
OPTIONS /users - mostra i verbi supportati riguardanti endpoint / utenti
OPTIONS /users/20 - mostra i verbi supportati relativi a endpoint / utenti / 20
Notare che Yii pluralizza automaticamente il nome del controller.
Step 3 - Ora, apri Postman, dai un pugno http://localhost:8080/userse fare clic su "Invia". Vedrai quanto segue.
Step 4 - Per creare un nuovo utente, modificare il tipo di richiesta in POST, aggiungere due parametri del corpo: nome ed e-mail e fare clic su "Invia".
Step 5 - Puoi usare il file fieldsparametro per specificare quali campi devono essere inclusi nel risultato. Ad esempio, l'URLhttp://localhost:8080/users?fields=id, name restituirà solo il id e name campi come mostrato nello screenshot seguente.