レスポンスのフォーマット ¶

RESTful APIリクエストを処理する場合、アプリケーションは通常、レスポンスのフォーマットに関連する以下の手順を実行します。

1. メディアタイプ、言語、バージョンなど、レスポンスフォーマットに影響を与える可能性のある様々な要因を決定します。このプロセスは、コンテンツネゴシエーション とも呼ばれます。
2. リソース セクションで説明されているように、リソースオブジェクトを配列に変換します。これは、yii\rest\Serializer によって行われます。
3. コンテンツネゴシエーションの手順で決定されたフォーマットで、配列を文字列に変換します。これは、レスポンスフォーマッター によって行われ、response アプリケーションコンポーネント のformatters プロパティに登録されています。

コンテンツネゴシエーション ¶

Yiiは、yii\filters\ContentNegotiator フィルターを介してコンテンツネゴシエーションをサポートしています。RESTful APIの基本コントローラークラスであるyii\rest\Controller は、contentNegotiatorという名前でこのフィルターを備えています。このフィルターは、レスポンスフォーマットのネゴシエーションと、言語のネゴシエーションを提供します。たとえば、RESTful APIリクエストに次のヘッダーが含まれている場合、

Accept: application/json; q=1.0, */*; q=0.1

次のJSON形式のレスポンスを取得します。

$ curl -i -H "Accept: application/json; q=1.0, */*; q=0.1" "https:///users"

HTTP/1.1 200 OK
Date: Sun, 02 Mar 2014 05:31:43 GMT
Server: Apache/2.2.26 (Unix) DAV/2 PHP/5.4.20 mod_ssl/2.2.26 OpenSSL/0.9.8y
X-Powered-By: PHP/5.4.20
X-Pagination-Total-Count: 1000
X-Pagination-Page-Count: 50
X-Pagination-Current-Page: 1
X-Pagination-Per-Page: 20
Link: <http:///users?page=1>; rel=self,
      <http:///users?page=2>; rel=next,
      <http:///users?page=50>; rel=last
Transfer-Encoding: chunked
Content-Type: application/json; charset=UTF-8

[
    {
        "id": 1,
        ...
    },
    {
        "id": 2,
        ...
    },
    ...
]

RESTful APIコントローラーアクションが実行される前に、yii\filters\ContentNegotiator フィルターは、リクエスト内のAccept HTTPヘッダーをチェックし、レスポンスフォーマット を'json'に設定します。アクションが実行され、結果のリソースオブジェクトまたはコレクションが返されると、yii\rest\Serializer は結果を配列に変換します。最後に、yii\web\JsonResponseFormatter は配列をJSON文字列にシリアライズし、レスポンスボディに含めます。

デフォルトでは、RESTful APIはJSONとXMLの両方のフォーマットをサポートしています。新しいフォーマットをサポートするには、APIコントローラークラスで次のようにcontentNegotiatorフィルターのformats プロパティを設定する必要があります。

use yii\web\Response;

public function behaviors()
{
    $behaviors = parent::behaviors();
    $behaviors['contentNegotiator']['formats']['text/html'] = Response::FORMAT_HTML;
    return $behaviors;
}

formatsプロパティのキーはサポートされているMIMEタイプで、値はyii\web\Response::$formattersでサポートされている対応するレスポンスフォーマット名です。

データのシリアライズ ¶

上記で説明したように、yii\rest\Serializer は、リソースオブジェクトまたはコレクションを配列に変換する責任を負う中心的な部分です。yii\base\Arrayableとyii\data\DataProviderInterfaceを実装するオブジェクトを認識します。前者は主にリソースオブジェクトによって実装され、後者はリソースコレクションによって実装されます。

シリアライザは、yii\rest\Controller::$serializer プロパティに設定配列を指定することで設定できます。例えば、クライアント側の開発作業を簡素化するために、ページネーション情報をレスポンスボディに直接含めたい場合があります。そのためには、yii\rest\Serializer::$collectionEnvelope プロパティを次のように設定します。

use yii\rest\ActiveController;

class UserController extends ActiveController
{
    public $modelClass = 'app\models\User';
    public $serializer = [
        'class' => 'yii\rest\Serializer',
        'collectionEnvelope' => 'items',
    ];
}

その後、https:///usersのリクエストに対して、次のレスポンスが得られます。

HTTP/1.1 200 OK
Date: Sun, 02 Mar 2014 05:31:43 GMT
Server: Apache/2.2.26 (Unix) DAV/2 PHP/5.4.20 mod_ssl/2.2.26 OpenSSL/0.9.8y
X-Powered-By: PHP/5.4.20
X-Pagination-Total-Count: 1000
X-Pagination-Page-Count: 50
X-Pagination-Current-Page: 1
X-Pagination-Per-Page: 20
Link: <http:///users?page=1>; rel=self,
      <http:///users?page=2>; rel=next,
      <http:///users?page=50>; rel=last
Transfer-Encoding: chunked
Content-Type: application/json; charset=UTF-8

{
    "items": [
        {
            "id": 1,
            ...
        },
        {
            "id": 2,
            ...
        },
        ...
    ],
    "_links": {
        "self": {
            "href": "https:///users?page=1"
        },
        "next": {
            "href": "https:///users?page=2"
        },
        "last": {
            "href": "https:///users?page=50"
        }
    },
    "_meta": {
        "totalCount": 1000,
        "pageCount": 50,
        "currentPage": 1,
        "perPage": 20
    }
}

JSON出力の制御 ¶

JSONレスポンスは、内部でJSONヘルパーを使用するJsonResponseFormatterクラスによって生成されます。このフォーマッタは、例えば$prettyPrintオプション（開発時における読みやすいレスポンスに役立ちます）や、JSONエンコーディングの出力を制御するための$encodeOptionsなど、さまざまなオプションで設定できます。

このフォーマッタは、アプリケーションの設定において、responseアプリケーションコンポーネントのformattersプロパティで次のように設定できます。

'response' => [
    // ...
    'formatters' => [
        \yii\web\Response::FORMAT_JSON => [
            'class' => 'yii\web\JsonResponseFormatter',
            'prettyPrint' => YII_DEBUG, // use "pretty" output in debug mode
            'encodeOptions' => JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE,
            // ...
        ],
    ],
],

DAOデータベースレイヤーを使用してデータベースからデータを取得する場合、すべてのデータは文字列として表現されます。これは常に期待される結果ではなく、特に数値はJSONでは数値として表現されるべきです。データベースからデータを取得する際にActiveRecordレイヤーを使用すると、数値列の値はyii\db\ActiveRecord::populateRecord()でデータベースからデータがフェッチされた際に整数に変換されます。