Форматирование ответов

При обработке запроса RESTful API приложение обычно выполняет следующие шаги, связанные с форматированием ответа:

1. Определяются различные факторы, которые могут повлиять на формат ответа, такие как тип носителя, язык, версия и т.д. Этот процесс также известен как переговоры о формате содержимого.
2. Объекты ресурсов преобразуются в массивы, как описано в разделе Ресурсы. Это выполняется с помощью yii\rest\Serializer.
3. Массивы преобразуются в строку в формате, определенном этапом переговоров о формате содержимого. Это выполняется с помощью форматеров форматов ответов, зарегистрированных в свойстве formatters компонента приложения response. Компоненты приложения.

Переговоры о формате содержимого

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" "http://localhost/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://localhost/users?page=1>; rel=self,
      <http://localhost/users?page=2>; rel=next,
      <http://localhost/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 в запросе и установит формат ответа на 'json'. После выполнения действия и возврата результирующего объекта или коллекции ресурсов, yii\rest\Serializer преобразует результат в массив. И, наконец, yii\web\JsonResponseFormatter сериализует массив в строку JSON и включит ее в тело ответа.

По умолчанию RESTful API поддерживают форматы JSON и XML. Чтобы добавить новый формат, вы должны настроить свойство formats фильтра contentNegotiator в ваших классах контроллеров API следующим образом:

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

Вы можете получить следующий ответ для запроса http://localhost/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://localhost/users?page=1>; rel=self,
      <http://localhost/users?page=2>; rel=next,
      <http://localhost/users?page=50>; rel=last
Transfer-Encoding: chunked
Content-Type: application/json; charset=UTF-8

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

Управление выводом JSON

Ответ JSON генерируется классом JsonResponseFormatter, который будет использовать вспомогательный класс JSON внутри. Этот форматер можно настроить с различными опциями, например, с опцией $prettyPrint, которая полезна на этапе разработки для более удобного чтения ответов, или $encodeOptions для управления выводом кодирования JSON.

Форматер можно настроить в свойстве formatters компонента приложения response в конфигурации приложения конфигурация, как показано ниже:

'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().