Paginação com $after em REST

A paginação restringe grandes conjuntos de dados a páginas menores e gerenciáveis. No REST, o Data API builder (DAB) usa o parâmetro query para paginação do conjunto de chaves, fornecendo uma travessia $after estável e eficiente através de resultados ordenados. Cada token marca a posição do último registro da página anterior, permitindo que a próxima solicitação continue a partir desse ponto. Ao contrário da paginação offset, a paginação do conjunto de chaves evita linhas ausentes ou duplicadas quando os dados são alterados entre as solicitações.

Vá para a versão GraphQL deste documento.

Visão rápida

Paginação básica

Neste exemplo, estamos recebendo os três primeiros livros.

Pedido HTTP

GET /api/books?$first=3

SQL conceitual

SELECT TOP (3)
  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" }
  ],
  "nextLink": "/api/books?$first=3&$after=eyJpZCI6M30="
}

Continuação com $after

O $after parâmetro especifica o token de continuação para a próxima página. O valor é uma cadeia de caracteres codificada em base64 que representa o último registro da página anterior.

Neste exemplo, estamos recebendo os próximos três livros após o token da última página.

Pedido HTTP

GET /api/books?$first=3&$after=eyJpZCI6M30=

SQL conceitual

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

Resposta da amostra

{
  "value": [
    { "id": 4, "title": "I, Robot" },
    { "id": 5, "title": "The Left Hand of Darkness" },
    { "id": 6, "title": "The Martian" }
  ],
  "nextLink": "/api/books?$first=3&$after=eyJpZCI6Nn0="
}

Fim dos dados

Quando nextLink está ausente, não há mais registros para buscar. A resposta da página final inclui apenas uma value matriz sem um nextLinkarquivo .

Resposta da amostra

{
  "value": [
    { "id": 7, "title": "Rendezvous with Rama" },
    { "id": 8, "title": "The Dispossessed" }
  ]
}

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