No desenvolvimento colaborativo de software, executar manualmente testes de API após cada commit de código pode rapidamente se tornar tedioso. Não seria melhor se esses testes pudessem ser executados automaticamente sempre que um novo código fosse enviado?
A boa notícia é que isso é totalmente possível. A maioria das equipes já usa plataformas de CI/CD para lidar com a construção e implantação de código, e essas plataformas são projetadas para escutar eventos de commit Git. Quando você envia código, elas executam automaticamente tarefas predefinidas, como compilar, empacotar ou implantar.
Executar testes automatizados de API não é diferente. O Apidog fornece uma ferramenta CLI que permite acionar testes automatizados com um único comando. Ao adicionar este comando ao seu pipeline de CI/CD, você pode garantir que os testes sejam executados automaticamente após cada submissão de código.
O processo de configuração é direto. O principal a entender é como o mecanismo de gatilho funciona, e então escolher a abordagem de integração correta com base na plataforma que sua equipe está usando.
Como os Gatilhos de Teste Automáticos Funcionam? (Os Princípios)
O cerne de todo o processo é "Escuta de Eventos + Execução de Comandos".
Quando você envia código para um repositório Git, a plataforma de CI/CD escuta este evento Git e, de acordo com sua configuração predefinida (como scripts de pipeline ou arquivos de configuração), executa automaticamente o comando de teste do Apidog.
Este princípio pode ser ilustrado da seguinte forma:
Existem principalmente duas maneiras para as plataformas de CI/CD escutarem eventos Git:
A primeira é o mecanismo de eventos integrado da plataforma. Por exemplo, o GitHub Actions pode ser especificado diretamente no arquivo de configuração: on: [push, pull_request]. Quando você envia código ou cria um PR, a plataforma escuta automaticamente esses eventos Git e inicia os testes.
A segunda é via Webhook, adequada para cenários como o Jenkins, onde a comunicação entre plataformas é necessária. Você terá que configurar manualmente uma URL de gatilho.
Independentemente do método, o passo final é sempre o mesmo: executar o comando apidog run para iniciar o teste automatizado.
Soluções de Integração para Plataformas Populares
Se você usa plataformas de hospedagem de código como GitHub ou GitLab, acionar testes é especialmente simples. Essas plataformas possuem serviços de CI/CD integrados (como GitHub Actions, GitLab CI) que podem escutar diretamente eventos Git e executar tarefas. Você pode consultar esta documentação para começar rapidamente:
No entanto, muitas equipes têm configurações mais complexas. Por exemplo, o código é hospedado no GitHub ou GitLab, mas o pipeline de CI/CD é executado no Jenkins. Neste caso, GitHub/GitLab e Jenkins são dois sistemas independentes — o primeiro não pode acionar diretamente o segundo.
Para cenários entre plataformas, os Webhooks são uma solução simples e eficaz. Um Webhook funciona como um mecanismo de callback — quando um evento específico (como um push Git) acontece no GitHub, ele envia ativamente uma solicitação para uma URL de Webhook predefinida para alertar um sistema externo. Ao oferecer um endpoint de Webhook, o Jenkins pode receber essas notificações e acionar automaticamente tarefas de teste.
Vamos ver uma configuração específica: o código é hospedado no GitHub, mas o pipeline de teste é executado no Jenkins.
Integração GitHub + Jenkins para Executar Testes Automatizados do Apidog
Se sua equipe armazena código no GitHub, mas usa o Jenkins para executar tarefas de build, veja como você pode configurar:
Passo 1: Configurar o Jenkins e Obter a URL do Webhook
Primeiro, prepare a tarefa de teste no Jenkins. Siga a documentação Integrar com Jenkins para criar um projeto, configurar o comando de build e garantir que o comando CLI possa ser executado corretamente.
Em seguida, obtenha a URL do Webhook do Jenkins. Esta URL atua como um ponto de entrada para sistemas externos chamarem o Jenkins, e o GitHub a usará para acionar as tarefas de teste.
A maneira mais simples é instalar o plugin "Generic Webhook Trigger". Procure e instale-o na página de gerenciamento de plugins do Jenkins, depois reinicie o Jenkins.
Em seguida, vá para a página de configuração do seu projeto e habilite este plugin. O endereço do Webhook será:
http://<endereço do seu servidor Jenkins>/generic-webhook-trigger/invoke`
Por segurança, é recomendado definir um Token personalizado, então o endereço se torna:
http://<endereço do seu servidor Jenkins>/generic-webhook-trigger/invoke?token=<xxxxxx>Assim que tiver esta URL, você pode configurar o Webhook no GitHub.
Passo 2: Configurar o Webhook do GitHub
Vá para o seu "repositório GitHub → Settings → Webhooks", adicione um novo Webhook, insira o endereço da etapa anterior, defina o tipo de conteúdo para application/json, selecione push ou outros eventos que você deseja acionar o teste e salve a configuração.
Após a configuração, cada push de código acionará automaticamente o Jenkins para executar a tarefa de teste. Você pode enviar algum código para testar e verificar os logs de build do Jenkins e os resultados dos testes.
Passo 3: Verificar o Processo Completo
Quando você envia código para o GitHub, o Webhook configurado enviará uma notificação para o Jenkins. O Jenkins receberá a solicitação e iniciará a tarefa de build automaticamente. Você pode ver os logs de execução do teste no "Console" do projeto Jenkins e ver o relatório final do teste.
Configuração de Webhook para Outras Plataformas
Além do GitHub, outras plataformas de hospedagem de código também suportam Webhooks, como:
Os métodos de configuração são semelhantes. O ponto chave é entender o mecanismo de gatilho: um commit Git gera um evento, que é então usado para notificar a plataforma de CI/CD via escuta de eventos ou Webhook, acionando finalmente a execução automática do comando de teste.
Para mais métodos de integração de plataforma CI/CD, consulte a seção Integração CI/CD da documentação oficial do Apidog.