Skip to content

Guia sobre listagens

📌 Atenção: O objetivo desse guia é demonstrar padrões utilizados para listagem/obtenção de dados onde nessa estrutura é possível realizar filtragens, ordenações, paginações e solicitar informações adicionais. Muitos recursos obedecem a estrutura de entrada e saída apresentada aqui!

1{
2 "status": true,
3 "data": {
4 "registers": [
5 {
6 "id": 1,
7 "name": "Item 1"
8 },
9 {
10 "id": 2,
11 "name": "Item 2"
12 }
13 ],
14 "pagination": {
15 "limit": 10,
16 "offset": 0,
17 "pages": 5,
18 "registers": 42
19 }
20 }
21}

Paginação:

O campo "pagination" retorna os principais campos para entender como está sendo feito a exibição dos itens. Os parametros de páginação aceitos para esses recursos são: "limit" o que pode ser qualquer valor entre 1 e 100 e "offset" que serve para avançar entre os registros presentes na listagem.

Uappi is the most productive way to
build, deploy, and monitor software.

;