Padrões de Response

Formatos padronizados para respostas da API.

---

Sucesso (Single)

{
  "data": {
    "id": "uuid",
    "name": "Contrato X",
    "status": "draft"
  }
}

---

Sucesso (List com Paginação)

{
  "data": [...],
  "meta": {
    "total": 100,
    "page": 1,
    "pageSize": 20,
    "totalPages": 5
  }
}

---

Erro

{
  "statusCode": 400,
  "message": "Erro de validação",
  "errors": [
    { "field": "email", "message": "Email inválido" }
  ],
  "timestamp": "2026-01-23T10:00:00.000Z",
  "path": "/api/v1/contracts"
}

---

HTTP Status Codes

Código	Uso
200	Sucesso em GET, PUT, PATCH
201	Sucesso em POST (criação)
204	Sucesso em DELETE (sem conteúdo)
400	Erro de validação
401	Não autenticado
403	Sem permissão
404	Recurso não encontrado
500	Erro interno

---

Documento atualizado em Janeiro 2026