Nome
Identifição amigavel da rota dentro do projeto.
Documentação
Guia tecnico de configuração
Configure as rotas da sua API para que o Health Service possa monitorar disponibilidade, latencia e falhas.
Como funciona
Fluxo basico de monitoramento continuo.
O Health Service monitora os endpoints cadastrados realizando chamadas HTTP periodicas. Para cada rota, informe o metodo, a URL, os headers necessarios e o status HTTP esperado. Com essas informações, conseguimos verificar se sua API esta disponivel, medir o tempo de resposta e registrar incidentes automaticamente quando houver falhas.
Dados necessarios
Campos principais para cadastrar uma rota monitorada.
Metodo HTTP
GET, POST, PUT, PATCH ou DELETE, conforme o comportamento da rota.
URL
Endereco completo da rota que sera monitorada pelo Health Service.
Headers
Cabecalhos necessarios, como Authorization, Content-Type ou API keys.
Body
Corpo da requisição para metodos que precisam enviar dados.
Status esperado
Codigo HTTP considerado saudavel, por exemplo 200 ou 201.
Timeout
Tempo maximo aguardado antes de considerar a chamada indisponivel.
Exemplo
Modelo de configuração que pode ser usado como referencia.
{
"name": "Listar usuarios",
"method": "GET",
"url": "https://api.exemplo.com/users",
"headers": {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
},
"expected_status": 200,
"timeout": 5000
}Metodos HTTP
Escolha o metodo pensando no impacto operacional da chamada.
Metodo GET
Use para validar rotas de consulta. Normalmente não precisa de body e costuma ser a melhor opção para monitoramento continuo.
Boas praticas
Recomendações para manter o monitoramento seguro e previsivel.
Use rotas seguras para monitoramento.
Evite endpoints que criam, alteram ou removem dados reais.
Configure timeout adequado para a realidade da sua API.
Use tokens com permissão limitada.
Prefira endpoints como /health, /status ou /ping.
Não exponha secrets diretamente no front.
Rota ideal
Prefira endpoints dedicados, de leitura e com resposta pequena.
GET /health
Uma rota simples de status permite validar aplicação, banco e versão sem alterar dados.
{
"status": "ok",
"database": "connected",
"version": "1.0.0"
}Criar endpoint
Body exibido no front ao orientar a integração com a API.
{
"name": "Health Check",
"method": "GET",
"url": "https://api.exemplo.com/health",
"headers": {
"Content-Type": "application/json"
},
"body": null,
"expected_status": 200,
"timeout": 5000
}Autenticação
Use headers quando a rota monitorada exigir credenciais.
Se a rota exigir autenticação, informe os headers necessarios. O token sera enviado junto com a requisição feita pelo Health Service.
{
"Authorization": "Bearer seu-token-aqui"
}Recomendamos usar tokens especificos para monitoramento, com permissoes minimas.
Estados da tela
Estados esperados para telas que carregam informações dinamicas.
Loading
Carregando guia tecnico.
Empty
Nenhuma configuração encontrada.
Error
Não foi possivel carregar as informações do guia.
Success
Guia carregado normalmente.
Evite cadastrar rotas que modificam dados reais, como criação de pedidos, exclusão de usuarios ou pagamentos. Para monitoramento continuo, prefira endpoints proprios de status, health check ou rotas de leitura.