Yii - API RESTful

Yii fornisce le seguenti utili funzionalità per l'implementazione delle API RESTful:

  • Prototipazione rapida
  • Serializzazione degli oggetti personalizzabile
  • Formato di risposta (che supporta JSON e XML per impostazione predefinita)
  • Formattazione dei dati di raccolta ed errori di convalida
  • Routing efficiente
  • Supporto per HATEOAS
  • Supporto integrato per i verbi OPTIONS e HEAD
  • Memorizzazione nella cache dei dati e cache HTTP
  • Autenticazione e autorizzazione
  • Limitazione della velocità

Per mostrare le API RESTful in azione, abbiamo bisogno di dati.

Preparazione del DB

Step 1- Crea un nuovo database. Il database può essere preparato nei due modi seguenti.

  • Nel terminale eseguire mysql -u root –p .

  • Creare un nuovo database tramite CREATE DATABASE helloworld CHARACTER SET utf8 COLLATE utf8_general_ci;

Step 2 - Configurare la connessione al database in config/db.phpfile. La seguente configurazione è per il sistema attualmente utilizzato.

<?php
   return [
      'class' => 'yii\db\Connection',
      'dsn' => 'mysql:host = localhost;dbname = helloworld',
      'username' => 'vladimir',
      'password' => '12345',
      'charset' => 'utf8',
   ];
?>

Step 3 - All'interno della cartella principale run ./yii migrate/create test_table. Questo comando creerà una migrazione del database per la gestione del nostro DB. Il file di migrazione dovrebbe apparire nel filemigrations cartella della radice del progetto.

Step 4 - Modifica il file di migrazione (m160106_163154_test_table.php in questo caso) in questo modo.

<?php
   use yii\db\Schema;
   
   use yii\db\Migration;
   class m160106_163154_test_table extends Migration {
      public function safeUp() {
         $this->createTable("user", [ "id" => Schema::TYPE_PK, "name" => Schema::TYPE_STRING, "email" => Schema::TYPE_STRING, ]); $this->batchInsert("user", ["name", "email"], [
            ["User1", "[email protected]"],
            ["User2", "[email protected]"],
            ["User3", "[email protected]"],
            ["User4", "[email protected]"],
            ["User5", "[email protected]"], 
            ["User6", "[email protected]"],
            ["User7", "[email protected]"],
            ["User8", "[email protected]"],
            ["User9", "[email protected]"],
            ["User10", "[email protected]"],
            ["User11", "[email protected]"],
         ]);
      }
      public function safeDown() {
         $this->dropTable('user');
      }
   }
?>

La migrazione di cui sopra crea un file usertabella con questi campi: id, nome ed email. Aggiunge anche alcuni utenti demo.

Step 5 - All'interno della radice del progetto run ./yii migrate per applicare la migrazione al database.

Step 6 - Ora, dobbiamo creare un modello per il nostro usertavolo. Per motivi di semplicità, utilizzeremo ilGiistrumento di generazione del codice. Apri questourl: http://localhost:8080/index.php?r=gii. Quindi, fare clic sul pulsante "Start" sotto l'intestazione "Generatore di modelli". Compilare il nome della tabella ("utente") e la classe del modello ("MyUser"), fare clic sul pulsante "Anteprima" e infine fare clic sul pulsante "Genera".

Il modello MyUser dovrebbe apparire nella directory dei modelli.

Installazione di Postman

Postman è uno strumento utile quando si sviluppa un servizio RESTful. Fornisce un'utile interfaccia per la costruzione delle richieste.

Puoi trovare questo strumento su https://chrome.google.com/webstore/detail/postman/fhbjgbiflinjbdggehcddcbncdddomop?hl=en .

Per installarlo, premere il pulsante "Aggiungi a Chrome".