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

页面摘要： 一个交互式查询构建器（query builder）工具，可根据你的端点和参数自动生成 REST API 查询 URL，由 qs 库提供支持，用于处理复杂的嵌套查询。

可以使用并组合多种参数，通过 REST API 查询你的内容，这可能会导致非常长且复杂的查询 URL。

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

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

  1. 将 Endpoint（端点）和 Endpoint Query Parameters（端点查询参数）字段中的值替换为你所需的内容。
  2. 点击 Copy to clipboard（复制到剪贴板）按钮，复制会随着你输入而自动更新的 Query String URL（查询字符串 URL）。
参数用法

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

NOTE

默认端点路径以 /api/ 为前缀，应保持不变，除非你通过 the rest.prefix API 配置选项 配置了不同的 API 前缀。 例如，要使用默认 API 前缀查询 books 集合类型，请在 Endpoint（端点）字段中输入 /api/books。

免责声明（Disclaimer）

本页提供的 qs 库和交互式查询构建器：

  • 可能无法检测到所有语法错误，
  • 并不知道 Strapi 项目中可用的参数和值，
  • 也不提供自动补全（autocomplete）功能。

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