Paginação

A paginação é uma forma de particionamento de dados, utilizada para permitir a consulta em APIs que retornam muitos dados, como listagens. As APIs que possuem paginação retornam um campo cursor, que contém as referências utilizadas para navegar nas páginas.

A consulta da primeira página pode ser feita sem passar nenhum parâmetro para a API, nas consultas das páginas seguintes deve ser passado o parâmetro de query cursor, onde deve ser repassado o id que foi retornado dentro do campo cursor.next na resposta da página anterior. Para busca de uma página anterior, deve ser utilizado o campo cursor.previous.

Exemplo da consulta da API

GET /api/v1/vpn/certs?cursor=id
{
  "cursor": {
    "current": "Aoyc5feKgmFGhgESFupoL",
    "previous": "Aoyc5feKgmFGhgESFupoL",
    "next": "AtFK8NbXeWfpqfP9UtecT",
    "count": 2,
  },
  "data": [
    {
      "id": "Aoyc5feKgmFGhgESFupoL",
      "name": "joaos01",
      "description": "João da Silva",
      "email": "joaos01@empresa.com",
      "created_at": "2017-10-05T12:20:02.932000+00:00",
      "expiry_date": "2027-10-05T12:20:02.932000+00:00"
    },
    {
      "id": "AtFK8NbXeWfpqfP9UtecT",
      "name": "jalves",
      "description": "José Alves",
      "email": "jalves@empresa.com",
      "created_at": "2017-10-05T12:20:02.932000+00:00",
      "expiry_date": "2027-10-05T12:20:02.932000+00:00"
    }
  ]
}

Formato dos dados

cursor.currentstring Id do cursor atual
cursor.previousstring Id do cursor anterior Se não houver página anterior o valor do previous será vazio
cursor.nextstring Id do próximo cursor Se não houver próximo, o valor será vazio
cursor.countinteger Contagem dos dados
dataobject Retorna lista de objeto da página atual