Skip to main content

REST API 参数

¥REST API parameters

API 参数可与 REST API 一起使用来对结果进行筛选、排序和分页,以及选择要填充的字段和关系。此外,还可以使用与可选 Strapi 功能相关的特定参数,例如内容类型的发布状态和区域设置。

¥API parameters can be used with the REST API to filter, sort, and paginate results and to select fields and relations to populate. Additionally, specific parameters related to optional Strapi features can be used, like the publication state and locale of a content-type.

以下 API 参数可用:

¥The following API parameters are available:

运算符类型描述
populate字符串或对象填充关系、组件或动态区域
fields数组仅选择要显示的特定字段
filters目的过滤响应
locale字符串选择语言环境
status字符串选择草稿和发布状态
sort字符串或数组对响应进行排序
pagination目的翻阅条目

查询参数使用 LHS 括号语法(即它们使用方括号 [] 进行编码)。

¥Query parameters use the LHS bracket syntax (i.e. they are encoded using square brackets []).

提示

可以使用和组合各种 REST API 参数来查询你的内容,这可能导致查询 URL 长而复杂。
你可以使用 Strapi 的 交互式查询构建器 工具更方便地构建查询 URL。🤗

¥A wide range of REST API parameters can be used and combined to query your content, which can result in long and complex query URLs.
You can use Strapi's interactive query builder tool to build query URLs more conveniently. 🤗