Endpoint GET /health - Verifica status aplicação

GET /health

Descrição

O endpoint GET /health é utilizado para verificar o status da aplicação. Este serviço retorna uma resposta simples que indica se a aplicação está funcionando corretamente.

Parâmetros

Nenhum parâmetro

Este endpoint não requer nenhum parâmetro.

Respostas

Sucesso (200)


Json
pong

Indica que a aplicação está funcionando corretamente.

Tipo de Mídia

  • text/plain


Erro Interno (5xx)


Indica que ocorreu um erro interno no servidor durante o processamento da requisição. Isso pode significar que a aplicação não está funcionando corretamente ou há algum problema interno.


Este endpoint é uma maneira rápida e fácil de verificar se a aplicação está ativa e operante. Se você receber um status 200 com a resposta "pong", a aplicação está funcionando conforme esperado. Se houver um status de erro 5xx, isso indica que há um problema que precisa ser resolvido.


Exemplo do Swagger: