yii2
Restful API

Zacznij od reszty interfejsu API

Mamy tabelę zawierającą kraje, dlatego tworzymy model o nazwie model listy krajów

<?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',
        ];
    }
}

i tworzę w tym celu usługę web rest, tworzymy kontroler dla restapi i ustawiamy zmienną modelClass dla naszego modelu.

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

do korzystania z restapi potrzebujemy ładnych adresów URL i
dodajemy tę regułę dla ładnego adresu URL

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

po czym uzyskamy dostęp do możemy przetestować nasz interfejs API odpoczynku jako przykład

http: // localhost / countrylist podaje nam listę powiatów.

Jak zastąpić domyślne działania spoczynkowego interfejsu API Yii2

Na przykład chcesz wyłączyć paginację w domyślnej akcji indeksu i uzyskać wszystkie wyniki w indeksie. Jak możesz to robić? To proste. Powinieneś zastąpić akcję indeksu w kontrolerze w następujący sposób:

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

Zastąp typ zawartości dla określonej akcji

Przypadek użycia: tylko jedna akcja, która powinna zwrócić zwykłą (tekstową) treść taką, jaka jest:

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

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

Wstępnie zdefiniowane formaty odpowiedzi to:

• FORMAT_HTML
• FORMAT_XML
• FORMAT_JSON
• FORMAT_JSONP
• FORMAT_RAW

Po wyjęciu z pudełka nie ma typu MIME dla text/plain , użyj tego zamiast:

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
}