REST API 参数

页面摘要： REST API 参数用于对 Strapi 查询进行过滤、排序、分页，并选择要返回的字段与关联。使用 filters、locale、populate、sort 与 pagination 来细化你的内容请求。

API 参数可与 REST API 配合使用，对结果进行过滤、排序与分页，并选择要联表加载（populate）的字段与关联。此外，还可以使用与 Strapi 可选功能相关的特定参数，例如 content-type 的发布状态与区域（locale）。

可用的 API 参数如下：

参数	类型	说明
`filters`	Object	过滤响应
`_q`	String	在 content-type 的各个字段中搜索匹配某字符串的条目
`locale`	String	选择区域（locale）
`status`	String	选择草稿与发布（Draft & Publish）状态
`publicationFilter`	String	根据草稿版本与已发布版本的关联关系筛选文档
`populate`	String 或 Object	联表加载关联、组件或动态区域
`fields`	Array	仅选择要显示的特定字段
`sort`	String 或 Array	对响应进行排序
`pagination`	Object	翻页浏览条目

NOTE

参数中较长的方括号编码列表（例如 populate 或 fields）受到 strapi::query 上的 arrayLimit 限制。参见联表加载（Population）。

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

TIP

REST API 提供了大量可组合使用的参数来查询内容，这可能会导致冗长而复杂的查询 URL。 👉 你可以使用 Strapi 的交互式查询构建器工具，更便捷地构建查询 URL。🤗