# Paginação

Como a API pagina resultados em listagens e consultas.

## Como enviar

Você pode escolher enviar os dados tanto no **Corpo da Requisição (Payload/JSON)**, quanto na própria **URL (Query Params)**. O comportamento da api será idêntico para as duas formas.

### Método 1: Via URL - Query Params:
Este é o padrão e mais recomendado. Anexando direto na URL da chamada. Ideal para navegações simples de páginas web.

```bash
GET https://api-dfe.dadosjah.com.br/v1/user/list?page=1&pageSize=20
```

### Método 2: Via Body (Carga JSON - rota GET):
Não é convencional, mas é possível enviar um body em uma requisição GET. Anexe o corpo da requisição em json.

```json
{  
  "page": 1,
  "pageSize": 20
}
```

### Parâmetros

#### pageSize:

**Descrição**: Número máximo de registros retornados por página.

**Orientação**: Utilize para controlar o volume de dados transferido e otimizar a performance da sua aplicação.

> **Dica:** Valores comuns recomendados: 10, 20 ou 50.

> **Atenção:** O valor máximo é 50.

#### page:

**Descrição**: Índice da página de resultados a ser consultada.

**Orientação**: A contagem das páginas começa em 1. Trabalha obrigatoriamente ligado ao pageSize para construir a navegação sobre a grade de dados da sua aplicação front-end.

## Retorno da consulta

### Campos

#### currentPage:

**Descrição**: O número da página atual retornada.

**Orientação**: Útil para exibir a paginação na interface do usuário (ex: "Página 1 de 5").

#### totalPages:

**Descrição**: Número total de páginas disponíveis, com base no pageSize e na quantidade total de itens.

**Orientação**: Essencial para construir controles de navegação.

#### totalItens:

**Descrição**: Número total de itens que correspondem à sua consulta em todas as páginas.

**Orientação**: Informa o número total de itens disponíveis para serem retornados.

### Exemplo

```json
{
    "statusCode": 201, 
    "data": {
	    ...        
        "currentPage": "1", 
        "totalPages": "2",//Enviado pageSize 10
        "totalItens": "17" 
    }
}
```