Limitar o tamanho da página com $first em REST

Limitar o tamanho da página evita sobrecarregar clientes ou servidores ao consultar grandes conjuntos de dados. No REST, o Data API builder (DAB) usa o $first parâmetro para controlar quantos registros são retornados em uma única resposta. O DAB aplica paginação baseada em cursor internamente, mas $first pode ser usado mesmo quando a continuação não é necessária.

Vá para a versão GraphQL deste documento.

Visão geral

Se $first for omitido, o tamanho de página padrão será aplicado automaticamente.

Padrão de utilização

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

Example

Limite os resultados a cinco livros.

GET /api/books?$first=5

SQL conceitual

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

Resposta da amostra

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

Regras de validação

Exemplo de mensagem de erro

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

Configuração de exemplo

{
  "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" ]
        }
      }
    }
  }
}

Consulte também