yii2
API Restful

Commence avec api de repos

Nous avons un tableau qui comprend des pays, donc nous créons un modèle qui s'appelle le modèle de 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',
        ];
    }
}

et je crée un Webservice de repos pour cela, nous créons un contrôleur pour restapi et définissons la variable modelClass pour notre modèle.

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

pour utiliser restapi, nous avons besoin de jolies urls et
nous ajoutons cette règle pour une jolie URL

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

après cela, nous accédons à peut tester notre reste api à titre d'exemple

http: // localhost / countrylist nous donne la liste des comtés.

Comment remplacer les actions par défaut de repos api Yii2

Par exemple, vous souhaitez désactiver la pagination dans votre action d'index par défaut et obtenir tous les résultats dans l'index. Comment peux-tu faire ça? C'est simple. Vous devriez remplacer l'action d'index dans votre contrôleur comme ceci:

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;
}

Remplacer le type de contenu pour une action spécifique

Cas d'utilisation: une seule action qui devrait renvoyer un contenu brut (texte) tel quel:

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

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

Les formats de réponse prédéfinis sont les suivants:

• FORMAT_HTML
• FORMAT_XML
• FORMAT_JSON
• FORMAT_JSONP
• FORMAT_RAW

Il n’existe pas de type MIME pour text/plain , utilisez plutôt ceci:

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
}