yii2
API riposante

Inizia con il riposo api

Abbiamo una tabella che include paesi, quindi creiamo un modello chiamato modello di countrylist

<?php

namespace app\models;

use Yii;

/**
 * This is the model class for table "countrylist".
 *
 * @property integer $id
 * @property string $iso
 * @property string $name
 * @property string $nicename
 * @property string $iso3
 * @property integer $numcode
 * @property integer $phonecode
 */
class Countrylist extends \yii\db\ActiveRecord
{
    /**
     * @inheritdoc
     */
    public static function tableName()
    {
        return 'countrylist';
    }

    /**
     * @inheritdoc
     */
    public function rules()
    {
        return [
            [['iso', 'name', 'nicename', 'phonecode'], 'required'],
            [['numcode', 'phonecode'], 'integer'],
            [['iso'], 'string', 'max' => 2],
            [['name', 'nicename'], 'string', 'max' => 80],
            [['iso3'], 'string', 'max' => 3]
        ];
    }

    /**
     * @inheritdoc
     */
    public function attributeLabels()
    {
        return [
            'id' => 'ID',
            'iso' => 'Iso',
            'name' => 'Name',
            'nicename' => 'Nicename',
            'iso3' => 'Iso3',
            'numcode' => 'Numcode',
            'phonecode' => 'Phonecode',
        ];
    }
}

e creo il webservice di riposo per questo, creiamo un controller per restapi e impostiamo la variabile modelClass per il nostro modello.

 <?php
    namespace app\controllers;
    use yii\rest\ActiveController;
    use Yii;
    class CountrylistController extends ActiveController
    {
      public $modelClass='app\models\Countrylist';
    }
?>

per l'utilizzo di restapi abbiamo bisogno di url piuttosto e
aggiungiamo questa regola per un bel URL

'urlManager' => [
   'class' => 'yii\web\UrlManager',
   'enablePrettyUrl' => true,
   'showScriptName' => false,
   'rules' => [
       ['class'=>'yii\rest\UrlRule','controller'=>'countrylist']
       ],
    ],

dopo di che abbiamo accesso a testare la nostra pausa API come esempio

http: // localhost / countrylist ci fornisce l'elenco delle contee.

Come sovrascrivere le azioni predefinite di rest api Yii2

Ad esempio, si desidera disabilitare l'impaginazione nell'azione indice predefinita e ottenere tutti i risultati in indice. Come puoi farlo? È semplice. Devi eseguire l'override dell'azione indice nel tuo controller in questo modo:

public function actions() {
    $actions = parent::actions();
    unset($actions['index']);
    return $actions;
}

public function actionIndex() {
    $activeData = new ActiveDataProvider([
        'query' => \common\models\Yourmodel::find(),
        'pagination' => false
    ]);
    return $activeData;
}

Sovrascrivi Content-Type per un'azione specifica

Caso d'uso: una sola azione che dovrebbe restituire un semplice contenuto (di testo) così com'è:

public function actionAsXML()
{
    $this->layout = false;
    Yii::$app->response->format = Response::FORMAT_XML;

    return ['aaa' => [1, 2, 3, 4]];;
}

I formati di risposta predefiniti sono:

• FORMAT_HTML
• FORMAT_XML
• FORMAT_JSON
• FORMAT_JSONP
• FORMAT_RAW

Non esiste un tipo mime per text/plain out of the box, usa invece:

public function actionPlainText()
{
    $this->layout = false;
    Yii::$app->response->format = Response::FORMAT_RAW;
    Yii::$app->response->headers->add('Content-Type', 'text/plain');

    return $this->render('plain-text'); // outputs template as plain text
}