Yii2のレスポンスにJSONやXMLを返す方法のまとめです。

Yiiは、昔ながらのスタティックなページ遷移のWebアプリケーションの方が向いているフレームワークですが、シングルページアプリケーションやAPIを公開に対応するにあたって、HTML以外のJSONやXMLを返す必要がある場合も多々あります。

そこで、Yii cookbookのGithubに調度良い記事「Working with different response types」があったので、試した内容を書き出してみました。

Yii2でのレスポンスフォーマットの指定方法

以下のコードはGiiのCRUD Generatorで作成したindexアクションです。

    public function actionIndex()
    {
        $searchModel = new ArticleSearch();
        $dataProvider = $searchModel->search(Yii::$app->request->queryParams);

        return $this->render('index', [
            'searchModel' => $searchModel,
            'dataProvider' => $dataProvider,
        ]);
    }

コントローラーのrenderメソッドは、Viewの実行結果のHTMLを返します。

Yiiのコントローラのアクションは、HTML文字列の他に以下のような型を返すことができます(つまりmixedです)

  • 配列
  • Arrayableインタフェースを実装するオブジェクト
  • 文字列
  • __toString()メソッドを実装したオブジェクト

加えて、Yiiは、各アクションで、returnの前に\Yii::$app->response->formatにレスポンスのフォーマットをセットできます。

\Yii::$app->response->format = \yii\web\Response::FORMAT_JSON;

指定できるフォーマット(参考)は以下のとおりです。

  • FORMAT_RAW
  • FORMAT_HTML
  • FORMAT_JSON
  • FORMAT_JSONP
  • FORMAT_XML

デフォルトはFORMAT_HTMLです。

JSONを返す

indexアクションをJSONを返すように修正すると以下のようになります。

    public function actionIndex()
    {
        \Yii::$app->response->format = \yii\web\Response::FORMAT_JSON;
        $articles = \app\models\Article::find()->all();
        return $articles;
    }

ActiveRecordオブジェクトの配列$articlesは、\yii\helpers\Json::encode()を使ってJSONに変換されます。
また、ActiveRecordeはArrayableインタフェースを実装しているので、簡単にJSONに変換できる仕組みになっています。

ブラウザで確認した結果です。
yii2-return-json

XMLを返す

XMLを帰す場合は、\Yii::$app->response->formatにセットする値をFORMAT_XMLに変更するだけです。

    public function actionIndex()
    {
        \Yii::$app->response->format = \yii\web\Response::FORMAT_XML;
        $articles = \app\models\Article::find()->all();
        return $articles;
    }

結果は以下のようになります。
yii2-return-xml

コントローラー全体でフォーマットを指定するには

コントローラーのすべてのアクションで、フォーマットをJSONにしたい場合は、以下のようにinitメソッドでセットすることができます。

    public function init()
    {
        parent::init();
        \Yii::$app->response->format = \yii\web\Response::FORMAT_JSON;
    }