Skip to content

LucasMofardini/health-check-api

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

37 Commits
 
 
 
 
 
 
 
 

Repository files navigation

🎉 Bem-vindo ao API Health Check Dashboard! 🚀

Introdução

Você já pensou em ter todas as suas APIs monitoradas em um só lugar? E se além disso, você pudesse ver a disponibilidade delas ao longo do tempo? Pois é, agora isso é possível! Apresento a vocês o API Health Check Dashboard! 🖥️📊

O que é o API Health Check Dashboard?

O API Health Check Dashboard é uma aplicação incrível onde você pode cadastrar suas APIs, definir os endpoints, especificar as respostas esperadas e configurar o intervalo de tempo para fazer o polling dessas APIs. Em outras palavras, você terá um painel de controle completo que monitora a saúde e a disponibilidade das suas APIs ao longo do tempo.

Funcionalidades Principais

  1. Cadastro de APIs:

    • 📋 Nome da API: Como você quer chamar essa API? Dê um nome legal!
    • 🌐 Endpoint: Qual é o endereço da sua API? Informe o URL.
    • 🔍 Resposta Esperada: Qual a resposta que você espera da API? Pode ser um código de status (200, 404, etc.) ou um conteúdo específico.
    • ⏲️ Intervalo de Polling: Com que frequência você quer verificar essa API? Defina o tempo em segundos, minutos ou horas.
  2. Dashboard de Disponibilidade:

    • 📈 Gráficos e Tabelas: Visualize a disponibilidade das suas APIs em gráficos intuitivos e tabelas detalhadas.
    • Histórico de Disponibilidade: Acompanhe o histórico de uptime e downtime das suas APIs.
    • 📊 Estatísticas Detalhadas: Veja estatísticas como tempo médio de resposta, número de verificações bem-sucedidas e falhas.

Como Funciona?

Cadastro de APIs

  1. Adicione uma nova API:
    • Preencha os campos obrigatórios: nome, endpoint, resposta esperada e intervalo de polling.
    • Clique em "Salvar" e pronto! Sua API está cadastrada.

Monitoramento

  1. Monitoramento Contínuo:
    • O sistema fará requisições automáticas às suas APIs nos intervalos definidos.
    • Os resultados das requisições serão armazenados e analisados.

Dashboard

  1. Visualize os Resultados:
    • Acesse o Dashboard para ver gráficos de disponibilidade e outras métricas importantes.
    • Analise o desempenho das suas APIs e identifique possíveis problemas.

Por que usar o API Health Check Dashboard?

  • Tranquilidade: Monitore suas APIs sem precisar se preocupar com verificações manuais.
  • Confiabilidade: Tenha certeza de que suas APIs estão funcionando corretamente e prontas para serem utilizadas.
  • Eficiência: Resolva problemas rapidamente ao visualizar o histórico e as métricas de disponibilidade.

Comece Agora!

Pronto para ter suas APIs sob controle? 🚀

  1. Instale a aplicação:

    git clone https://github.com/seu-repositorio/api-health-check-dashboard.git
    cd api-health-check-dashboard
    npm install
    npm start
  2. Abra o navegador e acesse http://localhost:3000.

  3. Cadastre suas APIs e comece a monitorar!


Divirta-se monitorando suas APIs e garantindo que tudo esteja sempre funcionando como esperado! 😄👍

Qualquer dúvida ou sugestão, sinta-se à vontade para entrar em contato. Happy coding! 💻✨


About

Generic Health Check Api With Microfront

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • C# 100.0%