Integrar com Github Actions
O Apidog oferece suporte à execução de testes automatizados em qualquer pipeline de CI/CD por meio de um comando simples de CLI. Esteja você usando GitHub Actions, GitLab CI, Jenkins ou um manipulador de webhook personalizado, você pode acionar testes do Apidog automaticamente sempre que o seu repositório Git for atualizado.Pré-requisitos#
Uma conta e um repositório do GitHub
Uma conta do Apidog com cenários de teste criados
Acesso para gerar tokens de acesso do Apidog
Como funciona#
A integração é baseada em um princípio simples: Git Webhook + execução via CLI.Quando um evento do Git (como um push ou pull request) ocorre, sua ferramenta de CI/CD recebe o evento e executa o comando apidog run para executar seus cenários de teste.Este guia usa o GitHub Actions como exemplo — porque ele é amplamente utilizado e não requer infraestrutura adicional. Porém, a mesma abordagem se aplica a outras plataformas.Essa configuração é ideal para:Executar automaticamente testes de API a cada push ou pull request
Monitorar branches específicas (por exemplo, main, develop)
Dar suporte a verificações pré-implantação e testes de regressão
Garantir uma execução de testes consistente em seus fluxos de trabalho de CI
Etapa 1: Inicializar um fluxo de trabalho do GitHub#
1.
Acesse GitHub e faça login na sua conta. 2.
Navegue até o repositório de destino.
3.
Clique na aba "Actions" na barra de navegação superior.
4.
Se esta for a primeira vez que você está configurando Actions no repositório, clique em "New workflow" para criar um.
Etapa 2: Gerar a configuração do GitHub Actions no Apidog#
1.
No Apidog, abra seu projeto e acesse a página "Tests".
2.
Alterne para a aba "CI/CD".
3.
Configure o ambiente de teste, decida se deseja habilitar dados de teste e defina a contagem de loops e o intervalo de atraso.
4.
Selecione "GitHub Actions" e clique em "Copy".
Etapa 3: Colar e fazer commit do fluxo de trabalho no GitHub#
1.
Retorne ao seu repositório do GitHub e abra a página Actions.
2.
Crie um novo fluxo de trabalho e cole o código de configuração copiado do Apidog.
3.
Se você já tiver um pipeline de CI existente, poderá mesclar a configuração de teste do Apidog nele.
4.
Clique em "Commit changes" para salvar e habilitar o fluxo de trabalho.
Certifique-se de substituir a variável $APIDOG_ACCESS_TOKEN no código pelo seu Access Token real. .github/workflows/.
Ele faz parte do seu código-fonte e será incluído quando você clonar ou fizer pull do projeto localmente. Você pode editá-lo em seu ambiente de desenvolvimento local e fazer commit das alterações por meio do Git, como qualquer outro arquivo.O topo do arquivo de fluxo de trabalho contém uma linha como:Isso informa ao GitHub para acionar automaticamente o fluxo de trabalho sempre que alguém enviar código por push ou abrir/atualizar um pull request. É uma sintaxe abreviada equivalente a uma versão mais detalhada e funciona bem para a maioria dos cenários de CI.Etapa 4: Executar o fluxo de trabalho e visualizar os resultados#
Depois de configurado, o fluxo de trabalho do GitHub Actions será executado automaticamente sempre que houver um novo commit de código. Você pode monitorar o status do fluxo de trabalho e os resultados dos testes na página Actions. Modified at 2026-06-11 10:21:25
