Endpoint GET /healthdb - Verifica conexão com base de dados

GET /healthdb

Descrição

O endpoint GET /healthdb é utilizado para verificar a conexão com a base de dados da aplicação. Este serviço retorna uma resposta simples que indica se a conexão com a base de dados está funcionando corretamente.

Parâmetros

Nenhum parâmetro

Este endpoint não requer nenhum parâmetro.

Respostas

Sucesso (200)


Json
{
  "message": "Database connection is healthy."
}

Indica que a conexão com a base de dados está funcionando corretamente.

Tipo de Mídia

  • application/json

Não Autorizado (401)

Indica que a solicitação não foi autorizada. Isso pode ocorrer se as credenciais de autenticação estiverem ausentes ou incorretas.

Este endpoint é uma maneira rápida e fácil de verificar se a conexão com a base de dados da aplicação está ativa e operante. Se você receber um status 200 com a mensagem indicando que a conexão está saudável, a base de dados está funcionando conforme esperado. Se houver um status de erro 401, isso indica que há um problema de autenticação que precisa ser resolvido.

Exemplo do Swagger: