Saúde do serviço
Verificação simples de que a API está no ar.
Verifica se a API está no ar
GET /health
Não exige login. Serve para monitorar se o serviço responde.
Acesso: Pública (sem login). Status de sucesso: 200.
Resposta
| Campo | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
status | "ok" | "degraded" | sim | ||
db | "up" | "down" | sim | ||
version | string | sim | ||
locale | string | sim |
Em caso de erro: modelo ErroApi.
Exemplo
bash
curl -X GET "$API/health"