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

¥Build your query URL with Strapi's interactive tool

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

¥A wide range of parameters can be used and combined to query your content with the REST API, which can result in long and complex query URLs.

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

¥Strapi's codebase uses the qs library to parse and stringify nested JavaScript objects. It's recommended to use qs directly to generate complex query URLs instead of creating them manually.

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

¥You can use the following interactive query builder tool to generate query URLs automatically:

1. 将端点和端点查询参数字段中的值替换为适合你需要的内容。

   ¥Replace the values in the Endpoint and Endpoint Query Parameters fields with content that fits your needs.

2. 单击“复制到剪贴板”按钮可复制自动生成的查询字符串 URL，该 URL 会在你键入时更新。

   ¥Click the Copy to clipboard button to copy the automatically generated Query String URL which is updated as you type.

参数使用

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

¥Please refer to the REST API parameters table and read the corresponding parameters documentation pages to better understand parameters usage.

Endpoint:Please keep the /api/ part unless you explicitly configured it differently in your project.

Endpoint Query Parameters:

Feel free to modify the code above.

Query String URL:

¥

Endpoint:Please keep the /api/ part unless you explicitly configured it differently in your project.

Endpoint Query Parameters:

{
sort: ['title:asc'],
filters: {
  title: {
    $eq: 'hello',
  },
},
populate: {
  author: {
    fields: ['firstName', 'lastName']
  }
},
fields: ['title'],
pagination: {
  pageSize: 10,
  page: 1,
},
status: 'published',
locale: 'en',
}

Feel free to modify the code above.

Query String URL:

注意

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

¥The default endpoint path is prefixed with /api/ and should be kept as-is unless you configured a different API prefix using the rest.prefix API configuration option.
For instance, to query the books collection type using the default API prefix, type /api/books in the Endpoint field.

免责声明

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

¥The qs library and the interactive query builder provided on this page:

• 可能无法检测到所有语法错误，

  ¥might not detect all syntax errors,

• 不知道 Strapi 项目中可用的参数和值，

  ¥are not aware of the parameters and values available in a Strapi project,

• 并且不提供自动补齐功能。

  ¥and do not provide autocomplete features.

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

¥Currently, these tools are only provided to transform the JavaScript object in an inline query string URL. Using the generated query URL does not guarantee that proper results will get returned with your API.