📐 Padrão de Response

Todas as respostas da API seguem um formato JSON padronizado, que contém metadados de execução junto ao conteúdo principal da requisição.

✅ Exemplo de Sucesso (com paginação)

{
    "status": "OK",
    "date": "2025-08-29T14:44:09.028145",
    "contentType": "application/json",
    "content": [
        {
            "id": 11,
            "nome_fantasia": "CASE LIFE - LOJA 02",
            "cnpj": "23.976.773/0003-75"
        }
    ],
    "pageNumber": 1,
    "size": 100,
    "totalElements": 1,
    "totalPages": 1,
    "first": true,
    "last": true,
    "success": true
}

📋 Estrutura da Response

Campo	Tipo	Descrição
`status`	string	Status textual da resposta. Segue os valores definidos no objeto HttpStatus do Java (ex.: `OK`, `NOT_FOUND`, `UNAUTHORIZED`).
`date`	string (ISO 8601)	Data e hora da resposta.
`contentType`	string	Tipo do conteúdo retornado (ex.: `application/json`).
`content`	array/objeto	Dados principais da resposta (clientes, pedidos, etc.).
`pageNumber`	int	Número da página retornada (em respostas paginadas).
`size`	int	Quantidade de registros por página.
`totalElements`	int	Total de registros disponíveis.
`totalPages`	int	Quantidade total de páginas disponíveis.
`first`	boolean	Indica se esta é a primeira página.
`last`	boolean	Indica se esta é a última página.
`success`	boolean	Indica se a operação foi concluída com sucesso. Pode ser true mesmo em casos como `NOT_FOUND`.

🔍 Exemplo de Não Encontrado – `NOT_FOUND`

{
    "status": "NOT_FOUND",
    "date": "2025-08-29T14:45:02.290213",
    "contentType": "application/json",
    "content": [],
    "pageNumber": 1,
    "size": 100,
    "totalElements": 0,
    "totalPages": 0,
    "first": true,
    "last": true,
    "success": true
}

❌ Exemplo de Erro – `UNAUTHORIZED`

{
    "status": "UNAUTHORIZED",
    "date": "2025-08-29T14:50:01.123456",
    "contentType": "application/json",
    "content": [],
    "pageNumber": 0,
    "size": 0,
    "totalElements": 0,
    "totalPages": 0,
    "first": true,
    "last": true,
    "success": false
}

📌 Observações importantes

O campo status segue os valores padronizados do HttpStatus do Java.

O campo success não é equivalente ao código HTTP: ele pode ser true mesmo em casos como NOT_FOUND.

Sempre valide status primeiro para determinar o comportamento correto.

Trate NOT_FOUND e NO_CONTENT como cenários válidos sem dados.

Em falhas críticas (BAD_REQUEST, UNAUTHORIZED, INTERNAL_SERVER_ERROR), espere que success = false.

Padrão de Response

📐 Padrão de Response#

✅ Exemplo de Sucesso (com paginação)#

📋 Estrutura da Response#

🔍 Exemplo de Não Encontrado – NOT_FOUND#