参数 Parameters

使用 API 参数来优化您的 Strapi REST API 查询。

API 参数可与 REST API 一起使用,以过滤、排序和分页结果并选择要填充的字段和关系。此外,还可以使用与可选 Strapi 功能相关的特定参数,例如内容类型的发布状态和语言环境。

可用的 API 参数如下:

运算符类型描述
populate字符串或对象填充关系、组件或动态区域
fields数组仅选择要显示的特定字段
filters对象过滤响应
locale字符串或数组选择一个或多个语言环境
publicationState字符串选择草稿和发布状态

仅接受以下值:
  • live(默认)
  • preview
sort字符串或数组对响应进行排序
pagination对象翻阅条目

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

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

在 Strapi 4.13+ 中,发送无效的查询参数将导致错误状态,而不是忽略它们。请确保您仅查询以下字段:

  • 参数格式正确
  • 不是私人或密码字段
  • 您已获得读取权限

如果您需要 API 具有忽略无效参数的旧行为,则需要自定义控制器以仅进行清理而不进行验证。