Ao realizar uma solicitação para uma API que retorna um ou mais recursos, eles serão retornados em grupos chamados páginas. Cada página conterá um número máximo de elementos.
Por padrão, o número máximo de elementos por página é 25, e o número máximo que pode ser retornado é 100. São fornecidos os parâmetros especiais page e size para facilitar a navegação através de conjuntos de dados maiores.
Ao realizar uma solicitação com paginação, os seguintes dados são incluídos no objeto de resposta para facilitar a navegação pelas páginas anteriores, atuais, seguintes, primeiras e últimas do conjunto de dados resultante.
O parâmetro page começa em 0; quando este valor é enviado, indica-se ao servidor que está sendo solicitada a primeira página.
Portanto, se quisermos solicitar a quarta página com um limite de 14 elementos por página, devemos enviar os seguintes parâmetros na solicitação: ?page=3&size=14.
curl https://api.osigu.com/v1/products?page=1&size=5{
"content": [],
"total_pages": 4,
"number_of_elements": 5,
"total_elements": 20,
"first_page": false,
"last_page": false,
"_links": {
"next": {
"href": "https://api.osigu.com/v1/products?page=2&size=5"
},
"first": {
"href": "https://api.osigu.com/v1/products?page=0&size=5"
},
"last": {
"href": "https://api.osigu.com/v1/products?page=3&size=5"
},
"self": {
"href": "https://api.osigu.com/v1/products?page=1&size=5"
}
}
}
Em alguns casos, as APIs que retornam pequenos conjuntos de dados correspondentes a catálogos podem não agrupar os dados em páginas, mas sim devolver um simples array. Isso será especificado na documentação de cada API.