Integrar com o Github Actions
O Apidog suporta a execução de testes automatizados em qualquer pipeline CI/CD através de um simples comando CLI. Quer esteja a utilizar GitHub Actions, GitLab CI, Jenkins ou um handler de webhook personalizado, pode acionar testes do Apidog automaticamente sempre que o seu repositório Git for atualizado.Pré-requisitos#
Uma conta e um repositório GitHub
Uma conta Apidog com cenários de teste criados
Acesso para gerar tokens de acesso do Apidog
Como Funciona#
A integração baseia-se num princípio simples: Webhook Git + Execução CLI.Quando ocorre um evento Git (como um push ou pull request), a sua ferramenta CI/CD recebe o evento e executa o comando apidog run para executar os seus cenários de teste.Este guia utiliza o GitHub Actions como exemplo, porque é amplamente utilizado e não requer infraestrutura adicional. No entanto, a mesma abordagem aplica-se a outras plataformas.Esta configuração é ideal para:Executar automaticamente testes de API em cada push ou pull request
Monitorizar branches específicos (por exemplo, main, develop)
Suportar verificações pré-implementação e testes de regressão
Garantir uma execução de testes consistente nos seus workflows de CI
Passo 1: Inicializar um Workflow do GitHub#
1.
Aceda ao GitHub e inicie sessão na sua conta. 2.
Navegue para o repositório de destino.
3.
Clique no separador "Actions" na barra de navegação superior.
4.
Se esta for a primeira vez que configura Actions no repositório, clique em "New workflow" para criar um.
Passo 2: Gerar a Configuração do GitHub Actions no Apidog#
1.
No Apidog, abra o seu projeto e aceda à página "Tests".
2.
Mude para o separador "CI/CD".
3.
Configure o ambiente de teste, decida se pretende ativar dados de teste e defina a contagem de ciclos e o intervalo de atraso.
4.
Selecione "GitHub Actions" e, em seguida, clique em "Copy".
Passo 3: Colar e Fazer Commit do Workflow no GitHub#
1.
Regresse ao seu repositório GitHub e abra a página Actions.
2.
Crie um novo workflow e cole o código de configuração copiado do Apidog.
3.
Se já tiver um pipeline de CI existente, pode integrar a configuração de teste do Apidog nele.
4.
Clique em "Commit changes" para guardar e ativar o workflow.
Certifique-se de que substitui a variável $APIDOG_ACCESS_TOKEN no código pelo seu Token de Acesso real. .github/workflows/.
Faz parte do seu código-fonte e será incluído quando clonar ou fizer pull do projeto localmente. Pode editá-lo no seu ambiente de desenvolvimento local e fazer commit das alterações através do Git, como qualquer outro ficheiro.O topo do ficheiro de workflow contém uma linha como:Isto indica ao GitHub para acionar automaticamente o workflow sempre que alguém fizer push de código 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.Passo 4: Executar o Workflow e Ver os Resultados#
Depois de configurado, o workflow do GitHub Actions será executado automaticamente sempre que houver um novo commit de código. Pode monitorizar o estado do workflow e os resultados dos testes na página Actions. Modified at 2026-06-09 08:54:45
