Exemplo de paginação de API RESTful

Algumas organizações têm inventários com milhares de APs. Isso pode ser desafiador quando você deseja visualizar todos eles com uma solicitação get de API, porque por padrão, a resposta será devolvida sem paginação em uma única página. Você pode habilitar a paginação aos dados devolvidos adicionando parâmetros de cabeçalho HTTP e X-Page-LimitX-Page-Page X-Page-Total à solicitação GET da API. Isso ajuda você a saber se está recebendo todas as entradas disponíveis ou se precisa consultar as próximas páginas.

A X-Page-Limit definição é o número máximo de resultados por página. O limite é de 100 por padrão, e o valor máximo é de 1000. No entanto, há algumas exceções para isso.

A X-Page-Page definição é o número máximo de resultados de página.

A X-Page-Total lista define o número total de entradas. O total dependerá do que você está olhando e quantas entradas estão na lista.

Para ajustar qualquer uma dessas informações, os parâmetros de consulta podem ser adicionados ao final da URL web para a interface de API que você está usando. Dependendo da chamada de API, você pode precisar, em vez disso, adicionar os parâmetros ao final da URL "próxima" que é gerada e enviada no corpo de resposta (caso exista um "próximo").

Nota:

Ao reutilizações de blocos de código, substitua os valores de placeholder por valores reais, como seu símbolo de API, ID da organização, ID do site, nome de AP e assim por diante.

No exemplo a seguir, adicionar limite=2&page=47 ajustaria os parâmetros X-Page-Limit e X-Page-Page.

O exemplo abaixo mostra o formato de uma solicitação GET que inclui paginação:

A resposta que você recebe da Mist ao fazer a solicitação na interface web de Django será assim:

Consulte a referência da Mist API para obter mais informações sobre uso: Pagination