O Apidog CLI tem sido por muito tempo o ponto de entrada de linha de comando para executar testes de API a partir de um terminal, pipeline de CI, fluxo de trabalho de automação ou sistema externo.
apidog run --project <projectId> --test-scenario <scenarioId> --environment <environmentId>Essa base ainda importa. As equipes ainda precisam de uma maneira confiável de executar testes de API, gerar relatórios e manter portões de qualidade dentro do CI. Mas o desenvolvimento de API está mudando. Agentes de IA agora estão participando do design de API, geração de testes, depuração, migração e manutenção.
Para esses fluxos de trabalho, uma CLI não pode ser apenas o último passo que executa testes existentes. Ela também precisa fornecer aos Agentes uma maneira estável de ler ativos de API, criar ou atualizar ativos de teste, validar mudanças estruturadas, gravá-los de volta e verificar o resultado.
O Apidog CLI atualizado mantém a base original de execução de testes e a expande para uma camada de fluxo de trabalho para desenvolvedores, scripts e Agentes de IA. Este artigo explica por que a CLI importa mais na era dos Agentes de IA, o que mudou no Apidog CLI e como as equipes podem começar a usá-lo para automação de testes de API.
Por que a CLI importa mais na era dos Agentes de IA
Interfaces gráficas são projetadas para pessoas. Elas são visuais, flexíveis e úteis para exploração. Agentes de IA, no entanto, funcionam melhor com comandos estruturados, entradas previsíveis, saídas previsíveis e etapas de validação claras.
É aí que a CLI se torna importante. Uma CLI fornece a Agentes e scripts uma interface repetível para os mesmos recursos que os desenvolvedores gerenciam no Apidog: APIs, ambientes, variáveis, casos de teste, cenários de teste, suítes de teste, relatórios, dados de importação/exportação e muito mais.
Na prática, isso significa que o Apidog pode servir tanto a usuários humanos quanto a fluxos de trabalho automatizados. As pessoas continuam a projetar, depurar, revisar e colaborar na interface do produto. Agentes e automação podem usar a CLI para realizar operações controladas em torno desses mesmos ativos.
De apidog run para fluxos de trabalho completos de API e testes
A experiência anterior da CLI se concentrava principalmente na execução de testes. Isso tornou o apidog run útil como um portão de qualidade de CI, mas também significava que a CLI geralmente aparecia perto do final do fluxo de trabalho. A CLI atualizada expande a cobertura para mais recursos centrais do Apidog, para que a automação possa participar mais cedo: lendo o contexto do projeto, preparando ativos de teste, validando mudanças estruturadas e, em seguida, executando a verificação.
Com a CLI atualizada, usuários e Agentes podem trabalhar com recursos como:
- Projetos e metadados de projeto
- APIs e definições de API
- Ambientes e variáveis
- Casos de teste
- Cenários de teste
- Suítes de teste
- Relatórios
- Fluxos de trabalho de importação e exportação
- Contas, branches, runners e recursos de projeto relacionados
Isso muda o papel do Apidog CLI. Não é simplesmente uma maneira de executar testes depois que tudo está pronto. Ele agora pode participar mais cedo no ciclo de desenvolvimento, onde um Agente precisa entender o projeto, gerar ou atualizar ativos de teste, validar mudanças e, em seguida, executar a verificação.
Um ciclo mais seguro para testes guiados por Agentes
Quando um Agente de IA ajuda no desenvolvimento ou teste de API, a parte arriscada não é apenas gerar conteúdo. A parte arriscada é escrever conteúdo gerado em um projeto real sem estrutura ou verificação suficientes.
A CLI atualizada torna um ciclo mais seguro possível:
Este ciclo importa porque muitos recursos do Apidog são estruturados. Casos de teste e cenários de teste podem incluir dados de requisição, asserções, extração de variáveis, pré-processadores, pós-processadores, ordem dos passos, referências a ambientes e outros detalhes. Se um Agente adivinhar a estrutura, pequenos erros podem causar falhas de gravação, exibição incompleta na UI ou testes que não se comportam como esperado.
É por isso que cli-schema é uma parte importante da atualização. Antes de gravar um arquivo JSON complexo no Apidog, um Agente pode pedir à CLI para validar se os campos e a estrutura correspondem ao esquema esperado.
apidog cli-schema validate test-case-create --file ./test-case-create.json
apidog cli-schema validate test-scenario-update --file ./scenario-update.jsonEm resumo: deixe o Agente gerar, mas deixe a CLI validar antes que a gravação ocorra.
A CLI também pode fornecer dicas orientadas ao Agente na saída do comando. Após a criação ou atualização de um recurso, o próximo passo geralmente não é "parar". Um Agente mais confiável deve ler o recurso salvo de volta, confirmar a estrutura e executar testes quando apropriado. Essas dicas ajudam os Agentes a se moverem pelo fluxo de trabalho com menos pontos cegos.
Habilidades dão aos Agentes discernimento operacional
Comandos CLI dão a um Agente poder de execução. Habilidades dão a um Agente discernimento operacional.
Uma HABILIDADE não é apenas uma referência de comando. É mais próxima de um guia operacional escrito para Agentes de IA: quando usar um comando, qual comando deve vir primeiro, quais campos não devem ser adivinhados, quando validar, quando ler de volta e quando executar testes.
Por exemplo, um Agente confiável não deve sempre escrever manualmente um cenário de teste grande do zero. Um padrão mais seguro é frequentemente:
- Crie o cenário básico.
- Importe passos de APIs ou casos de teste existentes.
- Leia de volta a estrutura completa do cenário.
- Atualize asserções, extração de variáveis ou processadores em passos menores.
- Valide e execute o cenário.
As Habilidades tornam esses padrões explícitos. Elas ajudam os Agentes a evitar erros comuns, como usar o nome de campo errado, escolher o valor enum incorreto, pular a validação de esquema ou assumir que uma gravação bem-sucedida significa que o recurso final já está correto.
Apidog fornece 8 Habilidades complementares para ajudar os Agentes a entender comandos CLI, estruturas de recursos e fluxos de trabalho de tarefas. Juntos, a CLI e as Habilidades tornam o Apidog mais prático para o desenvolvimento e teste de API assistidos por IA.
Mudanças de projeto mais seguras com Branches de IA
Quando um Agente modifica recursos do projeto, segurança e revisibilidade importam. Por essa razão, a CLI atualizada também pode ser usada em conjunto com Branches de IA.
O Agente pode fazer mudanças em um branch isolado primeiro. A equipe pode revisar as diferenças, confirmar o resultado e então mesclar para o branch de destino. Isso ajuda a prevenir que mudanças automatizadas afetem diretamente o branch principal ou um branch de colaboração compartilhado.
O que isso desbloqueia em fluxos de trabalho reais
O valor da CLI atualizada é mais fácil de ver em fluxos de trabalho concretos.
Gerar testes a partir de definições de API
Um Agente pode ler definições de API de um projeto, gerar casos de teste, validar o JSON gerado com cli-schema, gravar os casos de teste no Apidog, lê-los de volta e executar a verificação. Isso transforma a geração de testes de uma sugestão única em um fluxo de trabalho controlado.
Manter cenários de teste complexos
Para cenários de múltiplos passos, o Agente pode importar passos de APIs ou casos de teste existentes primeiro, então atualizar asserções, variáveis ou processadores após ler de volta a estrutura completa. Isso reduz o risco de construir um cenário grande incorretamente em uma única passagem.
apidog test-scenario import-steps <scenarioId> --project <projectId> --source endpoint --ids <endpointIds> --sync manual
apidog test-scenario get <scenarioId> --project <projectId> --with-case-detailMover e reproduzir ativos de projeto
A CLI atualizada também melhora os fluxos de trabalho de importação e exportação para dados nativos do Apidog. Isso é útil para migração de projetos, reprodução de ambientes de clientes, cópia de configurações de teste ou movimentação de APIs, esquemas, casos de teste e cenários entre projetos.
apidog export --project <projectId> --format apidog --output ./project.apidog.json
apidog import --project <projectId> --format apidog --file ./project.apidog.jsonManter portões de qualidade de CI
As novas capacidades prontas para Agentes não substituem o CI. Elas o complementam. As equipes ainda podem usar apidog run como o ponto de entrada principal para a execução automatizada de testes e relatórios.
apidog run --project <projectId> --test-scenario <scenarioId> --environment <environmentId> -r "cli,html,junit" --out-dir ./apidog-reportsPrimeiros passos
Se você já tem o Apidog CLI instalado, verifique sua versão atual primeiro:
apidog -vSe a sua versão do Apidog CLI for anterior a 2.2.5, atualize a CLI antes de usar os novos recursos. Este número de versão refere-se ao Apidog CLI, não ao aplicativo Apidog.
Você pode pedir ao Agente de IA que está usando para instalar tanto o Apidog CLI quanto as Habilidades complementares, copiando este prompt:
Read the instructions and help me install Apidog CLI:
https://apidog.com/apidog-cli-installation-guide.mdSe você preferir instalá-lo ou atualizá-lo manualmente, execute:
npm install -g apidog-cli@latestPara a referência completa de comandos, veja Opções do Apidog CLI.
Experimente sua primeira tarefa de Agente
Após a instalação da CLI e das Habilidades, a maneira mais fácil de começar é dar ao seu Agente uma pequena tarefa de API de baixo risco. Por exemplo, peça a ele para criar um endpoint de verificação de saúde simples em um projeto Apidog, então leia-o de volta para confirmar o resultado.
Copie este prompt para o seu Agente de IA:
Use Apidog CLI to help me create my first API endpoint in Apidog. First, check my Apidog CLI setup and list the projects I can access. Ask me which project to use. After I confirm, create a simple GET /health endpoint named Health Check with a 200 response example. Validate any structured input before writing, then read the endpoint back and summarize what was created.Isso dá aos novos usuários um ponto de partida concreto: o Agente verifica a configuração, pergunta antes de gravar em um projeto, cria uma pequena definição de API e confirma o resultado salvo.
Próximos passos:
- Baixe o Apidog para projetar, depurar, testar e documentar APIs em um único espaço de trabalho.
- Saiba mais sobre o Apidog CLI para testes de API via linha de comando, automação de CI e fluxos de trabalho de Agentes de IA.
FAQ
O que é Apidog CLI?
Apidog CLI é uma ferramenta de linha de comando para executar testes de API, trabalhar com recursos de projetos Apidog e conectar ativos de API e teste do Apidog a fluxos de trabalho de automação.
O Apidog CLI pode executar testes de API em CI?
Sim. As equipes podem usar apidog run em pipelines de CI para executar testes de API, gerar relatórios e manter portões de qualidade automatizados em seus fluxos de trabalho de teste.
Como o Apidog CLI ajuda os Agentes de IA?
O Apidog CLI oferece aos Agentes de IA uma maneira estruturada de ler informações da API, gerar ou atualizar ativos de teste, validar mudanças, gravá-los no Apidog, ler o resultado de volta e executar testes para verificação.
O que é cli-schema no Apidog CLI?
cli-schema ajuda a validar arquivos JSON complexos antes que sejam gravados no Apidog. Isso reduz falhas de gravação, campos inválidos e loops de nova tentativa desnecessários quando Agentes criam ou atualizam casos de teste e cenários de teste.
Como instalo o Apidog CLI?
Você pode pedir a um Agente de IA para seguir o guia de instalação do Apidog CLI e instalar tanto a CLI quanto as Habilidades complementares, ou instalá-lo manualmente com npm install -g apidog-cli@latest.