api - 偏移量和限制应该在 API 响应正文中吗？

Question

带有 Limit 和 Offset 的分页通常用于从 API 返回大型数据集。

当 API 请求包含 Limit 和 Offset 值时，响应正文是否也应该包含相同的 Limit 和 Offset 值，或者这些字段在响应中是多余且不必要的？

许多示例显示响应正文中包含的限制和偏移量。如果请求者已经拥有此信息，这是最佳实践吗？出于什么目的？

示例请求：baseUrl.com/api/data?limit=50&offset=100

示例响应：

{
  "totalResults": 100000,
  "limit": 50,   // is this best practice or redundant?
  "offset": 100, // is this best practice or redundant?
  "count": 50,
  "items": [ ]  
}

标签： apipaginationlimitoffset

Answer 1

一些 API 为 Offset 和 Limit 设置了默认值。如果请求者未在请求中提供这些值，则响应仍会返回具有默认偏移和限制的项目。因此，我希望响应具有 Offset 和 Limit 的当前值，因此它不会混淆请求者。