使用 $first REST 限制页面大小

在查询大型数据集时，限制页面大小可防止压倒性的客户端或服务器。 在 REST 中，数据 API 生成器（DAB）使用 $first 参数来控制单个响应中返回的记录数。 DAB 在内部应用基于游标的分页，但 $first 即使不需要延续，也可以使用。

转到 本文档的 GraphQL 版本。

概述

如果 $first 省略，则会自动应用默认页面大小。

使用模式

GET /api/{entity}?$first=N

Example

将结果限制为五本书。

GET /api/books?$first=5

概念 SQL

SELECT TOP (5)
  id,
  sku_title AS title
FROM dbo.books
ORDER BY id ASC;

示例响应

{
  "value": [
    { "id": 1, "title": "Dune" },
    { "id": 2, "title": "Foundation" },
    { "id": 3, "title": "Hyperion" },
    { "id": 4, "title": "I, Robot" },
    { "id": 5, "title": "The Martian" }
  ]
}

验证规则

示例错误消息

Invalid number of items requested, first argument must be either -1 or a positive number within the max page size limit of 100000. Actual value: 0

示例配置

{
  "runtime": {
    "pagination": {
      "default-page-size": 100,
      "max-page-size": 100000
    }
  },
  "entities": {
    "Book": {
      "source": {
        "type": "table",
        "object": "dbo.books"
      },
      "mappings": {
        "sku_title": "title",
        "sku_price": "price"
      },
      "relationships": {
        "book_category": {
          "cardinality": "one",
          "target.entity": "Category",
          "source.fields": [ "category_id" ],
          "target.fields": [ "id" ]
        }
      }
    },
    "Category": {
      "source": {
        "type": "table",
        "object": "dbo.categories"
      },
      "relationships": {
        "category_books": {
          "cardinality": "many",
          "target.entity": "Book",
          "source.fields": [ "id" ],
          "target.fields": [ "category_id" ]
        }
      }
    }
  }
}

另请参阅