Class yii\rest\Serializer

用于返回集合中资源对象的索引名称（例如 items）。 在提供资源集合时使用。设置此选项并启用分页后 将以以下格式返回集合：

[
    'items' => [...],  // 假如设的索引是 "items"
    '_links' => {  // 分页链接集，此数据通过 Pagination::getLinks() 处理返回
        'self' => '...',
        'next' => '...',
        'last' => '...',
    },
    '_meta' => {  // Pagination::toArray() 返回的 meta 信息。
        'totalCount' => 100,
        'pageCount' => 5,
        'currentPage' => 1,
        'perPage' => 20,
    },
]

如果未设置此属性，则将直接返回资源数组，而不使用索引。 _links 和 _meta 中显示的分页信息被放置到 HTTP 头部以供访问。

HTTP 标头名称，包含有关数据项当前页数的信息。 在使用分页提供资源集合时使用此选项。

查询参数的名称，包含有关应返回哪些字段的信息 除了资源对象的 $fieldsParam 中列出的之外。

查询参数的名称，包含有关应返回哪些字段的信息 对于 yii\base\Model 对象，如果未提供参数或为空，则 yii\base\Model::fields() 定义的默认字段集 将被返回。

用于返回链接对象的索引名称（例如 _links）。 collectionEnvelope 设置后它才生效。

用于返回链接对象的索引名称（例如 _meta）。 collectionEnvelope 设置后它才生效。

HTTP 标头名称，包含有关数据项总页数的信息。 在使用分页提供资源集合时使用此选项。

HTTP 标头名称，包含有关数据项每页的数据个数的信息 在使用分页提供资源集合时使用此选项。

在序列化集合数据时是否保留数组键。 将其设置为 true 以允许将集合序列化为 JSON 对象时，数组键用于索引对应的模型对象。 无论如何，默认是将所有集合序列化为数组 如何索引数组。

参见 serializeDataProvider().

当前请求，未设置则默认应用中的 request 组件。

当前响应，未设置则默认应用中的 request 组件。

HTTP 标头名称，包含有关数据项总数的信息。 在使用分页提供资源集合时使用此选项。