交互式查询器 Interactive Query Builder

使用利用查询字符串库的交互式工具来构建查询 URL

使用 Strapi 的交互式工具构建您的查询 URL

可以使用和组合各种参数来使用 REST API 查询您的内容，这可能会导致查询 URL 很长且很复杂。

Strapi 的代码库使用 qs 库 来解析和字符串化嵌套的 JavaScript 对象。建议直接使用 qs 来生成复杂的查询 URL，而不是手动创建它们。

您可以使用以下交互式查询构建器工具自动生成查询 URL：

  1. 将 Endpoint 和 Endpoint 查询参数 字段中的值替换为您所需的内容。
  2. 单击 复制到剪贴板 按钮以复制自动生成的 查询字符串 URL，该 URL 会在您键入时更新。
参数用法

请参考REST API 参数表并阅读相应的参数文档页面，以更好地了解参数用法。

在这里替换books
bash
/api/books
替换这些键的值
json
{
  "sort": ["title:asc"],
  "filters": {
    "title": {
      "$eq": "hello"
    }
  },
  "populate": {
    "author": {
      "fields": ["firstName", "lastName"]
    }
  },
  "fields": ["title"],
  "pagination": {
    "pageSize": 10,
    "page": 1
  },
  "publicationState": "live",
  "locale": ["en"]
}
可生成对应的结果
bash
/api/abc?sort[0]=title:asc&filters[title][$eq]=hello&populate[author][fields][0]=firstName&populate[author][fields][1]=lastName&fields[0]=title&pagination[pageSize]=10&pagination[page]=1&publicationState=live&locale[0]=en

默认端点路径以 /api/ 为前缀，除非您使用 rest.prefix API 配置选项 配置了不同的 API 前缀，否则应保持原样。
例如，要使用默认 API 前缀查询 books 集合类型，请在 Endpoint 字段中键入 /api/books。

免责声明

此页面上提供的 qs 库和交互式查询生成器：

  • 可能无法检测到所有语法错误，
  • 不知道 Strapi 项目中可用的参数和值，
  • 并且不提供自动完成功能。

目前，这些工具仅用于在内联查询字符串 URL 中转换 JavaScript 对象。使用生成的查询 URL 并不能保证您的 API 将返回正确的结果。