Opções da CLI do Apidog

A CLI do Apidog é usada para executar testes automatizados e gerenciar recursos de projetos do Apidog a partir de um terminal ou pipeline de CI/CD. Ela oferece suporte à execução de testes, gerenciamento de recursos de design de API, ambientes e variáveis, importação e exportação, publicação de documentação, colaboração por branches e administração de projetos.

Sintaxe básica da CLI do Apidog

A maioria dos comandos de recursos de projeto usa --project <projectId> para especificar o projeto. Você pode usar --branch <branchName> para operar em uma branch específica. Se --branch for omitido, o servidor usará a branch padrão.

Autenticação

Antes de acessar projetos privados, faça login ou forneça um token de acesso.

Comando	Descrição	Exemplo
`login`	Faça login com um token de acesso e salve-o localmente.	`apidog login --with-token <token>`
`logout`	Faça logout e limpe o token local salvo.	`apidog logout`
`whoami`	Mostre informações sobre o usuário autenticado atual.	`apidog whoami`

Você também pode passar um token diretamente ao executar comandos:

Se você estiver usando GitHub Actions, poderá armazenar seu token de acesso em Settings --> Secrets and Variables --> Actions --> Repository variables do seu repositório. Em seguida, use ${{ vars.APIDOG_ACCESS_TOKEN }} para referenciá-lo.

Esquema da CLI

Use cli-schema para inspecionar e validar arquivos JSON antes de criar ou atualizar recursos complexos. Isso ajuda a reduzir falhas de requisição causadas por dados malformados.

Comando	Descrição	Exemplo
`cli-schema list`	Liste todas as chaves de esquema compatíveis com a CLI.	`apidog cli-schema list`
`cli-schema get`	Imprima o JSON Schema de um arquivo de dados de comando.	`apidog cli-schema get endpoint-create`
`cli-schema validate`	Valide um arquivo JSON local em relação a uma chave de esquema.	`apidog cli-schema validate endpoint-create --file ./endpoint.json`

As chaves de esquema geralmente combinam o caminho do comando e a ação, como endpoint-create, test-scenario-update e merge-request-create.

Equipes e projetos

Os comandos de equipe e projeto são o ponto de partida para gerenciar recursos por meio da CLI. Use-os para encontrar os IDs exigidos pelos comandos no nível do projeto.

Gerenciamento de equipes

Comando	Descrição	Exemplo
`team list`	Liste as equipes acessíveis à conta atual.	`apidog team list`
`team get`	Veja detalhes de uma equipe específica.	`apidog team get <teamId>`

Gerenciamento de projetos

Comando	Descrição	Exemplo
`project list`	Liste os projetos acessíveis à conta atual.	`apidog project list`
`project get`	Veja os detalhes do projeto.	`apidog project get <projectId>`
`project create`	Crie um projeto em uma equipe.	`apidog project create --team <teamId> --name "New Project"`

Configurações do projeto

Comando	Descrição	Exemplo
`project settings get`	Veja as configurações no nível do projeto.	`apidog project settings get --project <projectId>`
`project settings update`	Atualize as configurações do projeto com um arquivo JSON.	`apidog project settings update --project <projectId> --file ./project-settings.json`
`cli-schema get project-settings-update`	Veja o esquema para atualizações das configurações do projeto.	`apidog cli-schema get project-settings-update`

Ambientes e variáveis

Use estes comandos para gerenciar ambientes de execução, variáveis globais e variáveis de equipe usadas pela depuração de API e por testes automatizados.

Gerenciamento de ambientes

Comando	Descrição	Exemplo
`environment list`	Liste os ambientes em um projeto.	`apidog environment list --project <projectId>`
`environment get`	Veja detalhes do ambiente, como URLs base.	`apidog environment get <environmentId> --project <projectId>`
`environment create`	Crie um ambiente.	`apidog environment create <name> --project <projectId> --base-url <url>`
`environment update`	Atualize um ambiente.	`apidog environment update <environmentId> --project <projectId> --file ./environment.json`
`environment delete`	Exclua um ambiente.	`apidog environment delete <environmentId> --project <projectId>`
`cli-schema get environment-update`	Veja o esquema para atualizações de ambiente.	`apidog cli-schema get environment-update`

Gerenciamento de variáveis

Comando	Descrição	Exemplo
`variables list`	Liste variáveis por escopo.	`apidog variables list --project <projectId> --scope global`
`variables get`	Veja o valor de uma variável.	`apidog variables get --project <projectId> --scope global --key <key>`
`variables set`	Crie ou atualize uma variável.	`apidog variables set --project <projectId> --scope global --key <key> --value <value>`
`variables delete`	Exclua uma variável.	`apidog variables delete --project <projectId> --scope global --key <key>`
`variables import`	Importe variáveis de um arquivo local.	`apidog variables import --project <projectId> --scope global --file ./variables.json`
`variables export`	Exporte variáveis para um arquivo local.	`apidog variables export --project <projectId> --scope global --output ./variables.json`

Recursos de design de API

Use estes comandos para gerenciar recursos de design de API, incluindo endpoints de API HTTP, esquemas, pastas, regras de mock, parâmetros comuns, componentes de resposta e esquemas de segurança. Ao criar ou atualizar recursos complexos, recomenda-se executar primeiro cli-schema get <schemaKey> e cli-schema validate <schemaKey> --file <path>.

Endpoints de API HTTP

Comando	Descrição	Exemplo
`endpoint list`	Liste endpoints de API HTTP em um projeto.	`apidog endpoint list --project <projectId>`
`endpoint get`	Veja detalhes do endpoint.	`apidog endpoint get <endpointId> --project <projectId>`
`endpoint create`	Crie um endpoint a partir de um arquivo JSON.	`apidog endpoint create --project <projectId> --file ./endpoint.json`
`endpoint update`	Atualize um endpoint.	`apidog endpoint update <endpointId> --project <projectId> --file ./endpoint.json`
`endpoint delete`	Exclua um endpoint.	`apidog endpoint delete <endpointId> --project <projectId>`
`cli-schema get endpoint-create`	Veja o esquema para criação de endpoint.	`apidog cli-schema get endpoint-create`
`cli-schema get endpoint-update`	Veja o esquema para atualizações de endpoint.	`apidog cli-schema get endpoint-update`

Esquemas de dados

Comando	Descrição	Exemplo
`schema list`	Liste esquemas de dados em um projeto.	`apidog schema list --project <projectId>`
`schema get`	Veja detalhes do esquema.	`apidog schema get <schemaId> --project <projectId>`
`schema create`	Crie um esquema de dados a partir de um arquivo JSON.	`apidog schema create --project <projectId> --file ./schema.json`
`schema update`	Atualize um esquema de dados.	`apidog schema update <schemaId> --project <projectId> --file ./schema.json`
`schema delete`	Exclua um esquema de dados.	`apidog schema delete <schemaId> --project <projectId>`
`cli-schema get schema-create`	Veja o esquema para criação de esquema de dados.	`apidog cli-schema get schema-create`
`cli-schema get schema-update`	Veja o esquema para atualizações de esquema de dados.	`apidog cli-schema get schema-update`

Documentos Markdown

Comando	Descrição	Exemplo
`doc list`	Liste documentos Markdown.	`apidog doc list --project <projectId>`
`doc get`	Veja detalhes do documento Markdown.	`apidog doc get <docId> --project <projectId>`
`doc create`	Crie um documento Markdown.	`apidog doc create --project <projectId> --file ./doc.json`
`doc update`	Atualize um documento Markdown.	`apidog doc update <docId> --project <projectId> --file ./doc.json`
`doc delete`	Exclua um documento Markdown.	`apidog doc delete <docId> --project <projectId>`

Pastas de recursos

Use comandos folder para gerenciar árvores de pastas de diferentes tipos de recursos. A opção --type seleciona o tipo de recurso, como endpoint, schema, test-scenario, response-component, security-scheme, test-suite ou test-data.

Comando	Descrição	Exemplo
`folder list`	Liste pastas por tipo de recurso.	`apidog folder list --project <projectId> --type endpoint`
`folder create`	Crie uma pasta por tipo de recurso.	`apidog folder create --project <projectId> --type endpoint --name "New Folder"`
`folder move`	Mova uma pasta para outra pasta pai.	`apidog folder move <folderId> --project <projectId> --type endpoint --parent <parentId>`
`folder update`	Atualize o nome, a descrição ou a pasta pai.	`apidog folder update <folderId> --project <projectId> --type endpoint --name "New Folder Name"`
`folder delete`	Exclua uma pasta.	`apidog folder delete <folderId> --project <projectId> --type endpoint`
`cli-schema get folder-create`	Veja o esquema para criação de pasta.	`apidog cli-schema get folder-create`
`cli-schema get folder-update`	Veja o esquema para atualizações de pasta.	`apidog cli-schema get folder-update`

--type seleciona o tipo da pasta de recurso. Ele não é o nome da pasta. O campo description é compatível apenas com pastas de endpoint e test-scenario; outros tipos de pasta oferecem suporte apenas a atualizações de nome e pasta pai.

Regras de mock

Comando	Descrição	Exemplo
`mock list`	Liste regras de mock em um projeto ou sob um endpoint.	`apidog mock list --project <projectId> --http-api-id <endpointId>`
`mock get`	Veja uma regra de mock.	`apidog mock get <mockId> --project <projectId>`
`mock create`	Crie uma regra de mock a partir de um arquivo JSON.	`apidog mock create --project <projectId> --file ./mock.json`
`mock update`	Atualize uma regra de mock.	`apidog mock update <mockId> --project <projectId> --file ./mock.json`
`mock delete`	Exclua uma regra de mock.	`apidog mock delete <mockId> --project <projectId>`
`cli-schema get mock-create`	Veja o esquema para criação de regra de mock.	`apidog cli-schema get mock-create`
`cli-schema get mock-update`	Veja o esquema para atualizações de regra de mock.	`apidog cli-schema get mock-update`

Parâmetros comuns

Comando	Descrição	Exemplo
`common-parameter list`	Liste parâmetros comuns reutilizáveis.	`apidog common-parameter list --project <projectId>`
`common-parameter get`	Veja detalhes do parâmetro comum.	`apidog common-parameter get <commonParameterId> --project <projectId>`
`common-parameter create`	Crie um parâmetro comum a partir de um arquivo JSON.	`apidog common-parameter create --project <projectId> --file ./common-parameter.json`
`common-parameter update`	Atualize um parâmetro comum.	`apidog common-parameter update <commonParameterId> --project <projectId> --file ./common-parameter.json`
`common-parameter import`	Importe parâmetros comuns de um arquivo.	`apidog common-parameter import --project <projectId> --file ./common-parameters.json`
`common-parameter export`	Exporte parâmetros comuns para um arquivo local.	`apidog common-parameter export --project <projectId> --output ./common-parameters.json`

Componentes de resposta

Comando	Descrição	Exemplo
`response-component list`	Liste componentes de resposta reutilizáveis.	`apidog response-component list --project <projectId>`
`response-component get`	Veja detalhes do componente de resposta.	`apidog response-component get <responseComponentId> --project <projectId>`
`response-component create`	Crie um componente de resposta a partir de um arquivo JSON.	`apidog response-component create --project <projectId> --file ./response-component.json`
`response-component update`	Atualize um componente de resposta.	`apidog response-component update <responseComponentId> --project <projectId> --file ./response-component.json`
`response-component delete`	Exclua um componente de resposta.	`apidog response-component delete <responseComponentId> --project <projectId>`

Esquemas de segurança

Comando	Descrição	Exemplo
`security-scheme list`	Liste esquemas de segurança em um projeto.	`apidog security-scheme list --project <projectId>`
`security-scheme get`	Veja detalhes do esquema de segurança.	`apidog security-scheme get <schemeId> --project <projectId>`
`security-scheme create`	Crie um esquema de segurança a partir de um arquivo JSON.	`apidog security-scheme create --project <projectId> --file ./scheme.json`
`security-scheme update`	Atualize um esquema de segurança.	`apidog security-scheme update <schemeId> --project <projectId> --file ./scheme.json`
`security-scheme delete`	Exclua um esquema de segurança.	`apidog security-scheme delete <schemeId> --project <projectId>`

Caminhos de API são caminhos de recursos de API, não caminhos de arquivos locais. Se seu shell reescrever valores que começam com /, coloque o caminho entre aspas, por exemplo --path '/api/users', ou use --file para fornecer dados do endpoint.

Para casos de teste de API ou etapas HTTP de cenário de teste, responseId deve usar um ID de definição de resposta de endpoint de endpoint.responses[].id, não um ID de componente de resposta. Para reutilizar um componente de resposta, vincule-o primeiro na definição de resposta do endpoint.

Testes automatizados

Use estes comandos para gerenciar casos de teste de API, cenários de teste, suítes de teste, dados de teste, relatórios de teste, runners e tarefas agendadas.

Casos de teste de API

Comando	Descrição	Exemplo
`test-case list`	Liste casos de teste de API, opcionalmente filtrados por endpoint.	`apidog test-case list --project <projectId> --endpoint <endpointId>`
`test-case category`	Liste categorias de casos de teste.	`apidog test-case category --project <projectId>`
`test-case get`	Veja detalhes do caso de teste de API.	`apidog test-case get <caseId> --project <projectId>`
`test-case create`	Crie um caso de teste de API a partir de um arquivo JSON.	`apidog test-case create --project <projectId> --file ./case.json`
`test-case update`	Atualize um caso de teste de API.	`apidog test-case update <caseId> --project <projectId> --file ./case.json`
`test-case delete`	Exclua um caso de teste de API.	`apidog test-case delete <caseId> --project <projectId>`
`cli-schema get test-case-create`	Veja o esquema para criação de caso de teste.	`apidog cli-schema get test-case-create`
`cli-schema get test-case-update`	Veja o esquema para atualizações de caso de teste.	`apidog cli-schema get test-case-update`

Cenários de teste

Comando	Descrição	Exemplo
`test-scenario list`	Liste cenários de teste em um projeto.	`apidog test-scenario list --project <projectId>`
`test-scenario get`	Veja detalhes do cenário de teste.	`apidog test-scenario get <scenarioId> --project <projectId>`
`test-scenario create`	Crie um cenário de teste.	`apidog test-scenario create --project <projectId> --file ./scenario.json`
`test-scenario update`	Atualize um cenário de teste.	`apidog test-scenario update <scenarioId> --project <projectId> --file ./scenario.json`
`test-scenario delete`	Exclua um cenário de teste.	`apidog test-scenario delete <scenarioId> --project <projectId>`
`test-scenario run`	Execute um cenário de teste.	`apidog test-scenario run <scenarioId> --project <projectId> --environment <environmentId>`
`cli-schema get test-scenario-create`	Veja o esquema para criação de cenário de teste.	`apidog cli-schema get test-scenario-create`
`cli-schema get test-scenario-update`	Veja o esquema para atualizações de cenário de teste.	`apidog cli-schema get test-scenario-update`

Suítes de teste

Comando	Descrição	Exemplo
`test-suite list`	Liste suítes de teste em um projeto.	`apidog test-suite list --project <projectId>`
`test-suite get`	Veja detalhes da suíte de teste.	`apidog test-suite get <testSuiteId> --project <projectId>`
`test-suite create`	Crie uma suíte de teste.	`apidog test-suite create --project <projectId> --file ./suite.json`
`test-suite update`	Atualize uma suíte de teste.	`apidog test-suite update <testSuiteId> --project <projectId> --file ./suite.json`
`test-suite delete`	Exclua uma suíte de teste.	`apidog test-suite delete <testSuiteId> --project <projectId>`
`test-suite run`	Execute uma suíte de teste.	`apidog test-suite run <testSuiteId> --project <projectId> --environment <environmentId>`

Dados de teste

Comando	Descrição	Exemplo
`test-data list`	Liste conjuntos de dados de teste.	`apidog test-data list --project <projectId>`
`test-data get`	Veja detalhes do conjunto de dados de teste.	`apidog test-data get <dataId> --project <projectId>`
`test-data create`	Crie um conjunto de dados de teste a partir de um arquivo JSON.	`apidog test-data create --project <projectId> --file ./test-data.json`
`test-data update`	Atualize um conjunto de dados de teste.	`apidog test-data update <dataId> --project <projectId> --file ./test-data.json`
`test-data delete`	Exclua um conjunto de dados de teste.	`apidog test-data delete <dataId> --project <projectId>`

Relatórios de teste

Comando	Descrição	Exemplo
`test-report list`	Liste relatórios de teste em um projeto.	`apidog test-report list --project <projectId>`
`test-report get`	Veja detalhes do relatório de teste.	`apidog test-report get <reportId> --project <projectId>`
`test-report download`	Baixe um relatório de teste para um arquivo local.	`apidog test-report download <reportId> --project <projectId> --format json --output ./report.json`
`test-report delete`	Exclua um relatório de teste.	`apidog test-report delete <reportId> --project <projectId>`

Runners

Comando	Descrição	Exemplo
`runner list`	Liste runners em um projeto ou equipe.	`apidog runner list --project <projectId>`
`runner get`	Veja detalhes do runner.	`apidog runner get <runnerId> --project <projectId>`
`runner create`	Crie um runner de equipe.	`apidog runner create --team <teamId> --name <name> --runner-type <runnerType> --server-type <serverType>`
`runner check`	Verifique a integridade do runner.	`apidog runner check <runnerId> --team <teamId>`
`runner delete`	Exclua um runner.	`apidog runner delete <runnerId> --project <projectId>`

Tarefas agendadas

Comando	Descrição	Exemplo
`scheduled-task list`	Liste tarefas agendadas em um projeto.	`apidog scheduled-task list --project <projectId>`
`scheduled-task get`	Veja detalhes da tarefa agendada.	`apidog scheduled-task get <taskId> --project <projectId>`
`scheduled-task create`	Crie uma tarefa agendada a partir de um arquivo JSON.	`apidog scheduled-task create --project <projectId> --file ./scheduled-task.json`
`scheduled-task update`	Atualize uma tarefa agendada.	`apidog scheduled-task update <taskId> --project <projectId> --file ./scheduled-task.json`
`scheduled-task delete`	Exclua uma tarefa agendada.	`apidog scheduled-task delete <taskId> --project <projectId>`
`scheduled-task run`	Acione uma tarefa agendada manualmente.	`apidog scheduled-task run <taskId> --project <projectId>`

Comando principal de execução: `apidog run`

Este é o comando principal para executar cenários de teste, pastas de cenários de teste, suítes de teste ou arquivos exportados locais. Você pode copiar comandos gerados do painel de CI/CD do cliente Apidog e executá-los no terminal ou no fluxo de trabalho de CI/CD.

Execução online

Ao executar testes em tempo real por meio do servidor do Apidog, use o seguinte comando.

Use o token de acesso do Apidog com o ID de um cenário de teste, diretório de cenários de teste ou suíte de teste específico. Por exemplo:

Execução local

Ao executar testes offline usando arquivos exportados, use o seguinte comando.

Especifique a URL ou o caminho do arquivo do cenário de teste do Apidog. Por exemplo:

Opções de execução

Opção	Descrição
`--access-token <accessToken>`	Defina o token de autenticação para execução online
`-t, --test-scenario <testScenarioId>`	Especifique o ID do cenário de teste a executar
`-f, --test-scenario-folder <folderId>`	Especifique o ID do diretório de cenários de teste a executar
`--test-suite <testSuiteId>`	Especifique o ID da suíte de teste a executar
`--project <projectId>`	Especifique o ID do projeto
`--branch <branchName>`	Especifique o nome da branch; se omitido, o servidor usará a branch principal por padrão
`-r, --reporters [reporters]`	Especifique os tipos de relatório de teste (padrão: `["cli"]`)
`--out-dir <outDir>`	Diretório de saída para relatórios de teste (padrão: `./apidog-reports`)
`--out-file <outFile>`	Nome do arquivo de relatório de teste sem necessidade de adicionar uma extensão. Você pode usar `{FOLDER_NAME}`, `{SCENARIO_NAME}` e `{GENERATE_TIME}`
`--out-json-failures-separated <outJsonFailuresSeparated>`	Exporte falhas como arquivo JSON separado
`-e, --environment <environmentId>`	Especifique o ambiente de execução
`-n, --iteration-count <n>`	Defina o número de iterações
`-d, --iteration-data <path>`	Defina dados para iterações de casos (JSON ou CSV)
`--on-error <behavior>`	Defina o comportamento de tratamento de erros (`ignore`, `continue` ou `end`)
`--variables <path>`	Carregue variáveis de ambiente ou globais de um arquivo local
`--global-var <value>`	Defina variáveis globais (formato `key=value`)
`--env-var <value>`	Defina variáveis de ambiente (formato `key=value`)
`--notification <ids>`	Envie notificações depois que a execução terminar
`--notification-failed-event <ids>`	Envie notificações somente quando a execução falhar
`--external-program-path <path>`	Especifique o caminho de arquivo para programas externos
`--database-connection <path>`	Especifique o caminho de arquivo para configuração de banco de dados
`--ignore-redirects`	Impeça redirecionamentos automáticos
`--silent`	Impeça a saída no console
`--color <value>`	Ative ou desative saída colorida no console
`--delay-request [n]`	Especifique o atraso entre requisições (ms)
`--timeout-request [n]`	Especifique o tempo limite da requisição (ms)
`--timeout-script [n]`	Especifique o tempo limite de execução do script (ms)
`-k, --insecure`	Desative a verificação SSL
`--ssl-client-cert-list <path>`	Especifique o caminho da configuração do certificado do cliente
`--ssl-client-cert <path>`	Especifique o caminho do certificado do cliente (PEM)
`--ssl-client-key <path>`	Especifique o caminho da chave privada do certificado do cliente
`--ssl-client-passphrase <passphrase>`	Especifique a frase secreta do certificado do cliente
`--ssl-extra-ca-certs <path>`	Especifique certificados CA confiáveis adicionais
`-b, --bigint`	Ative a compatibilidade com bigint
`--upload-report [value]`	Envie a visão geral do relatório de teste para a nuvem
`--preferred-http-version <preferredHttpVersion>`	Defina a versão preferida do protocolo HTTP
`--verbose`	Exiba informações detalhadas de requisição e resposta
`--lang <language>`	Defina o idioma da CLI (en)
`-h, --help`	Exiba informações de ajuda

Ao criar ou atualizar recursos de teste complexos, como cenários de teste, suítes de teste, casos de teste, dados de teste ou tarefas agendadas, use primeiro cli-schema get <schemaKey> e depois valide seu arquivo local com cli-schema validate <schemaKey> --file <path>.

Importação e exportação

Use comandos de importação e exportação para trazer documentos de API externos para o Apidog ou exportar dados do projeto para formatos usados por outras ferramentas.

Importar dados do projeto

O comando import importa um arquivo local para um projeto. Os formatos compatíveis incluem openapi, postman, har, insomnia, jmeter, wsdl, yapi, rap2, apidoc, hoppscotch, markdown, jsonschema e apidog.

Comando	Descrição	Exemplo
`import`	Importe um arquivo local para um projeto por formato.	`apidog import --project <projectId> --format openapi --file ./openapi.json`

Configurações de importação automática

Use import auto-import para manter configurações de importação automática para sincronização de longo prazo a partir de fontes externas.

Comando	Descrição	Exemplo
`import auto-import list`	Liste configurações de importação automática em um projeto.	`apidog import auto-import list --project <projectId>`
`import auto-import create`	Crie uma configuração de importação automática.	`apidog import auto-import create --project <projectId> --file ./auto-import.json`
`import auto-import get`	Veja uma configuração de importação automática.	`apidog import auto-import get <settingId> --project <projectId>`
`import auto-import delete`	Exclua uma configuração de importação automática.	`apidog import auto-import delete <settingId> --project <projectId>`
`cli-schema get import-auto-import-create`	Veja o esquema para configurações de importação automática.	`apidog cli-schema get import-auto-import-create`

Exportar dados do projeto

O comando export exporta dados do projeto para um arquivo local. Os formatos compatíveis incluem openapi, markdown, html, postman e apidog.

Para exportação nativa apidog, o escopo oferece suporte a all, apis e tags. O escopo de pasta está disponível apenas para exportação OpenAPI.

Comando	Descrição	Exemplo
`export`	Exporte dados do projeto por formato.	`apidog export --project <projectId> --format openapi --output ./openapi.json`
`export --format apidog`	Exporte dados nativos do projeto.	`apidog export --project <projectId> --format apidog --output ./project.apidog.json`
`export --scope apis`	Exporte APIs selecionadas no formato nativo.	`apidog export --project <projectId> --format apidog --scope apis --api-ids 1001,1002 --output ./selected.apidog.json`
`export --scope tags`	Exporte APIs por tags no formato nativo.	`apidog export --project <projectId> --format apidog --scope tags --include-tags pet,store --output ./tagged.apidog.json`
`export --format openapi --scope folders`	Exporte pastas selecionadas no formato OpenAPI.	`apidog export --project <projectId> --format openapi --scope folders --folder-ids 2001 --output ./openapi.json`

Configurações de exportação OAS

Use export settings para manter configurações reutilizáveis de exportação OAS.

Comando	Descrição	Exemplo
`export settings list`	Liste configurações de exportação OAS.	`apidog export settings list --project <projectId>`
`export settings create`	Crie uma configuração de exportação OAS.	`apidog export settings create --project <projectId> --file ./export-setting.json`
`export settings get`	Veja uma configuração de exportação OAS.	`apidog export settings get <settingId> --project <projectId>`
`export settings update`	Atualize uma configuração de exportação OAS.	`apidog export settings update <settingId> --project <projectId> --file ./export-setting.json`
`export settings delete`	Exclua uma configuração de exportação OAS.	`apidog export settings delete <settingId> --project <projectId>`
`cli-schema get export-settings-create`	Veja o esquema para criação de configuração de exportação OAS.	`apidog cli-schema get export-settings-create`
`cli-schema get export-settings-update`	Veja o esquema para atualizações de configuração de exportação OAS.	`apidog cli-schema get export-settings-update`

Compartilhamento de documentação

Use estes comandos para publicar e compartilhar documentação de API.

Sites de documentação

Comando	Descrição	Exemplo
`docs-site list`	Liste sites de documentação.	`apidog docs-site list --project <projectId>`
`docs-site get`	Veja detalhes do site de documentação.	`apidog docs-site get <siteId> --project <projectId>`
`docs-site create`	Crie um site de documentação.	`apidog docs-site create --project <projectId> --file ./docs-site.json`
`docs-site update`	Atualize as configurações do site de documentação.	`apidog docs-site update <siteId> --project <projectId> --file ./docs-site.json`
`docs-site delete`	Exclua um site de documentação.	`apidog docs-site delete <siteId> --project <projectId>`

Documentos compartilhados

Comando	Descrição	Exemplo
`shared-doc list`	Liste documentos compartilhados.	`apidog shared-doc list --project <projectId>`
`shared-doc get`	Veja detalhes do documento compartilhado.	`apidog shared-doc get <docId> --project <projectId>`
`shared-doc create`	Crie um documento compartilhado.	`apidog shared-doc create --project <projectId> --file ./shared-doc.json`
`shared-doc update`	Atualize as configurações do documento compartilhado.	`apidog shared-doc update <docId> --project <projectId> --file ./shared-doc.json`
`shared-doc delete`	Exclua um documento compartilhado.	`apidog shared-doc delete <docId> --project <projectId>`

Gerenciamento de branches

Use comandos de branch para isolar alterações, colaborar em recursos do projeto e mesclar recursos selecionados entre branches.

Branches de iteração

Comando	Descrição	Exemplo
`branch list --type all`	Liste todos os tipos de branch em um projeto.	`apidog branch list --project <projectId> --type all`
`branch list --type sprint`	Liste branches de iteração.	`apidog branch list --project <projectId> --type sprint`
`branch get --type sprint`	Veja uma branch de iteração.	`apidog branch get <branchName> --project <projectId> --type sprint`
`branch create --type sprint`	Crie uma branch de iteração.	`apidog branch create --project <projectId> --type sprint --name <branchName> --from main`
`branch update --type sprint`	Atualize uma branch de iteração.	`apidog branch update <branchName> --project <projectId> --type sprint --name <newName>`
`branch merge`	Mescle recursos selecionados explicitamente de uma branch para outra.	`apidog branch merge --project <projectId> --from <sourceBranchName> --to <targetBranchName> --endpoint-ids <ids>`
`branch pick-to`	Escolha recursos selecionados de uma branch de origem para uma branch de destino.	`apidog branch pick-to --project <projectId> --from <sourceBranchName> --to <targetBranchName> --endpoint-ids <ids>`
`branch archive --type sprint`	Arquive uma branch de iteração antes da exclusão.	`apidog branch archive <branchName> --project <projectId> --type sprint`
`branch delete --type sprint`	Exclua uma branch de iteração arquivada.	`apidog branch delete <branchName> --project <projectId> --type sprint`

Branches de IA

Comando	Descrição	Exemplo
`branch list --type ai`	Liste branches de IA.	`apidog branch list --project <projectId> --type ai`
`branch get --type ai`	Veja uma branch de IA.	`apidog branch get <branchName> --project <projectId> --type ai`
`branch create --type ai`	Crie uma branch de IA a partir de uma branch de origem.	`apidog branch create --project <projectId> --type ai --name <aiBranchName> --from <sourceBranchName>`
`branch update --type ai`	Atualize uma branch de IA.	`apidog branch update <branchName> --project <projectId> --type ai --name <newName>`
`branch archive --type ai`	Arquive uma branch de IA antes da exclusão.	`apidog branch archive <branchName> --project <projectId> --type ai`
`branch delete --type ai`	Exclua uma branch de IA arquivada.	`apidog branch delete <branchName> --project <projectId> --type ai`

Branches gerais

Comando	Descrição	Exemplo
`branch list --type general`	Liste branches gerais.	`apidog branch list --project <projectId> --type general`
`branch get --type general`	Veja uma branch geral.	`apidog branch get <branchName> --project <projectId> --type general`
`branch create --type general`	Crie uma branch geral.	`apidog branch create --project <projectId> --type general --name <branchName> --from main`
`branch update --type general`	Atualize uma branch geral.	`apidog branch update <branchName> --project <projectId> --type general --name <newName>`
`branch delete --type general`	Exclua uma branch geral.	`apidog branch delete <branchName> --project <projectId> --type general`

Os comandos de criação de branch usam principalmente opções de linha de comando, como --type, --name e --from. cli-schema get branch-*-create é usado para inspecionar a estrutura das opções de criação. Para ver as opções reais do comando, execute apidog branch create -h.

Solicitações de merge

Use merge-request quando a branch de destino exigir um fluxo de revisão. Solicitações de merge e merges diretos mesclam apenas recursos selecionados explicitamente.

Comando	Descrição	Exemplo
`merge-request preview`	Examine alterações candidatas antes de criar uma solicitação de merge ou um merge direto.	`apidog merge-request preview --project <projectId> --from <sourceBranchName> --to <targetBranchName>`
`merge-request list`	Liste solicitações de merge.	`apidog merge-request list --project <projectId> --to <targetBranchName>`
`merge-request get`	Veja detalhes da solicitação de merge.	`apidog merge-request get <mergeRequestId> --project <projectId> --to <targetBranchName>`
`merge-request create`	Crie uma solicitação de merge.	`apidog merge-request create --project <projectId> --to <targetBranchName> --from <sourceBranchName> --reviewer-ids <userIds> --endpoint-ids <ids>`
`merge-request update`	Atualize uma solicitação de merge.	`apidog merge-request update <mergeRequestId> --project <projectId> --to <targetBranchName> --file ./merge-request.json`
`merge-request approve`	Aprove uma solicitação de merge.	`apidog merge-request approve <mergeRequestId> --project <projectId> --to <targetBranchName> --file ./approve.json`
`merge-request reject`	Rejeite uma solicitação de merge.	`apidog merge-request reject <mergeRequestId> --project <projectId> --to <targetBranchName>`
`merge-request delete`	Exclua uma solicitação de merge.	`apidog merge-request delete <mergeRequestId> --project <projectId> --to <targetBranchName>`

Para manter os recursos do projeto seguros, as permissões de gravação da CLI podem ser restritas por padrão. Você pode editar dados da branch de origem por meio de uma branch de IA ou habilitar permissões de edição externa nas configurações de recursos do projeto quando a edição direta for necessária para a branch principal, branches de iteração padrão ou branches gerais. Alterações feitas em uma branch de IA ainda precisam de confirmação do usuário antes de merge ou merge-request.

Recomenda-se que nomes de branches de IA incluam a data, a branch de origem e a finalidade, por exemplo ai/20260312-from-main-user-register.

Para operações de merge e escolha de branch, as opções de ID de recurso usam nomes no plural e IDs numéricos separados por vírgulas, como --endpoint-ids 1,2, --doc-ids 3,4 e --test-suite-ids 5,6.

Outros recursos

Use estes comandos para gerenciar recursos de extensão do projeto e conexões externas.

Campos personalizados

Comando	Descrição	Exemplo
`custom-field list`	Liste campos personalizados.	`apidog custom-field list --project <projectId>`
`custom-field create`	Crie um campo personalizado.	`apidog custom-field create --project <projectId> --file ./custom-field.json`
`custom-field update`	Atualize um campo personalizado.	`apidog custom-field update <customFieldId> --project <projectId> --file ./custom-field.json`
`custom-field delete`	Exclua um campo personalizado.	`apidog custom-field delete <customFieldId> --project <projectId>`

APIs WebSocket

Comando	Descrição	Exemplo
`websocket list`	Liste APIs WebSocket.	`apidog websocket list --project <projectId>`
`websocket get`	Veja detalhes da API WebSocket.	`apidog websocket get <websocketId> --project <projectId>`
`websocket create`	Crie uma API WebSocket.	`apidog websocket create --project <projectId> --name <name> --url <url>`
`websocket update`	Atualize uma API WebSocket.	`apidog websocket update <websocketId> --project <projectId> --file ./websocket.json`
`websocket delete`	Exclua uma API WebSocket.	`apidog websocket delete <websocketId> --project <projectId>`

APIs Socket.IO

Comando	Descrição	Exemplo
`socketio list`	Liste APIs Socket.IO.	`apidog socketio list --project <projectId>`
`socketio get`	Veja detalhes da API Socket.IO.	`apidog socketio get <socketioId> --project <projectId>`
`socketio create`	Crie uma API Socket.IO.	`apidog socketio create --project <projectId> --file ./socketio.json`
`socketio update`	Atualize uma API Socket.IO.	`apidog socketio update <socketioId> --project <projectId> --file ./socketio.json`
`socketio delete`	Exclua uma API Socket.IO.	`apidog socketio delete <socketioId> --project <projectId>`

Scripts comuns

Comando	Descrição	Exemplo
`common-script list`	Liste scripts comuns.	`apidog common-script list --project <projectId>`
`common-script get`	Veja detalhes do script comum.	`apidog common-script get <scriptId> --project <projectId>`
`common-script create`	Crie um script comum.	`apidog common-script create --project <projectId> --file ./common-script.json`
`common-script update`	Atualize um script comum.	`apidog common-script update <scriptId> --project <projectId> --file ./common-script.json`
`common-script delete`	Exclua um script comum.	`apidog common-script delete <scriptId> --project <projectId>`

Conexões de banco de dados

Comando	Descrição	Exemplo
`database-connection list`	Liste conexões de banco de dados.	`apidog database-connection list --project <projectId>`
`database-connection get`	Veja detalhes da conexão de banco de dados.	`apidog database-connection get <connectionId> --project <projectId>`
`database-connection create`	Crie uma conexão de banco de dados.	`apidog database-connection create --project <projectId> --file ./database-connection.json`
`database-connection update`	Atualize uma conexão de banco de dados.	`apidog database-connection update <connectionId> --project <projectId> --file ./database-connection.json`
`database-connection delete`	Exclua uma conexão de banco de dados.	`apidog database-connection delete <connectionId> --project <projectId>`

Provedores de cofre

Comando	Descrição	Exemplo
`vault list`	Liste provedores de cofre.	`apidog vault list --project <projectId>`
`vault get`	Veja detalhes do provedor de cofre.	`apidog vault get <vaultProviderId> --project <projectId>`
`vault create`	Crie um provedor de cofre.	`apidog vault create --project <projectId> --file ./vault.json`
`vault update`	Atualize um provedor de cofre.	`apidog vault update <vaultProviderId> --project <projectId> --file ./vault.json`
`vault delete`	Exclua um provedor de cofre.	`apidog vault delete <vaultProviderId> --project <projectId>`

Conexões Git

Comando	Descrição	Exemplo
`git-connection list`	Liste conexões Git.	`apidog git-connection list --project <projectId>`
`git-connection get`	Veja detalhes da conexão Git.	`apidog git-connection get <connectionId> --project <projectId>`
`git-connection create`	Crie uma conexão Git.	`apidog git-connection create --project <projectId> --file ./git-connection.json`
`git-connection update`	Atualize uma conexão Git.	`apidog git-connection update <connectionId> --project <projectId> --file ./git-connection.json`
`git-connection delete`	Exclua uma conexão Git.	`apidog git-connection delete <connectionId> --project <projectId>`

Gerenciamento e configurações

Use estes comandos para administração de projetos, notificações, recursos da lixeira, histórico de alterações e logs de auditoria.

Notificações

Comando	Descrição	Exemplo
`notification list`	Liste configurações de notificação.	`apidog notification list --project <projectId>`
`notification get`	Veja detalhes da notificação.	`apidog notification get <notificationId> --project <projectId>`
`notification create`	Crie uma configuração de notificação.	`apidog notification create --project <projectId> --file ./notification.json`
`notification update`	Atualize uma configuração de notificação.	`apidog notification update <notificationId> --project <projectId> --file ./notification.json`
`notification delete`	Exclua uma configuração de notificação.	`apidog notification delete <notificationId> --project <projectId>`

Lixeira

Comando	Descrição	Exemplo
`recycle list`	Liste recursos na lixeira.	`apidog recycle list --project <projectId>`
`recycle restore`	Restaure um recurso da lixeira.	`apidog recycle restore <itemId> --project <projectId>`
`recycle delete`	Exclua permanentemente um recurso da lixeira.	`apidog recycle delete <itemId> --project <projectId>`

Histórico

Comando	Descrição	Exemplo
`history list`	Liste o histórico de alterações do projeto.	`apidog history list --project <projectId>`
`history get`	Veja detalhes do histórico de alterações.	`apidog history get <historyId> --project <projectId>`

Logs de auditoria

Comando	Descrição	Exemplo
`audit-log list`	Liste logs de auditoria do projeto.	`apidog audit-log list --project <projectId>`
`audit-log get`	Veja detalhes do log de auditoria.	`apidog audit-log get <auditLogId> --project <projectId>`

Uso avançado

Upload de arquivos na CLI

Ao trabalhar com APIs que exigem upload de arquivos, definir corretamente o caminho do arquivo a ser enviado é crucial. Você deve armazenar o arquivo na mesma máquina em que os testes são executados e referenciá-lo usando o caminho absoluto ou relativo. Siga estas etapas para referenciar um arquivo para upload.

Copie previamente o arquivo necessário para a máquina que executa a CLI. Por exemplo, se você estiver usando GitHub Actions como seu pipeline de CI/CD, copie o arquivo necessário para o mesmo repositório GitHub do seu fluxo de trabalho.

No Apidog, navegue até seu cenário de teste e localize a etapa que exige upload de arquivo. Clique no botão Bulk Edit, conforme mostrado abaixo.

Botão de edição em lote nos detalhes da etapa do cenário de teste

Copie o caminho do arquivo que você copiou para a máquina da CLI. Em seguida, substitua o valor do parâmetro do campo de arquivo pelo caminho do arquivo na máquina da CLI. Por exemplo, se você colocar um arquivo png na pasta data em um repositório GitHub, poderá usar data/to-be-uploaded.png para referenciá-lo.

Configuração do caminho do arquivo no modo de edição em lote

Após essa configuração, o arquivo poderá ser enviado corretamente ao Apidog por meio da CLI.

Se você quiser executar esse cenário de teste localmente novamente, precisará modificar o caminho do arquivo no valor do parâmetro de volta para o caminho na sua máquina local.

Usar operações de banco de dados na CLI

Quando seus cenários de teste incluem operações de banco de dados, você precisa realizar algumas etapas extras porque as configurações de banco de dados são salvas localmente, não na nuvem. Isso significa que você não pode executar a CLI diretamente em modo de nuvem para esses cenários. Veja como lidar com essa situação:

Para cenários de teste que incluem operações de banco de dados, você verá um prompt na interface de geração da linha de comando: "Download the database configuration file."

Baixe esse arquivo e coloque-o no diretório em que você pretende executar a CLI do Apidog.

A linha de comando gerada automaticamente incluirá a opção --database-connection. Você pode usar essa linha de comando como está para executar seus testes.

Enviar relatórios de teste locais da CLI para a nuvem

Para enviar seus relatórios de teste locais da CLI para a nuvem, você pode adicionar o parâmetro --upload-report ao final do comando da CLI. Veja como fazer isso:

Adicione o parâmetro --upload-report ao comando da CLI:

Este comando executará seus testes e enviará automaticamente o relatório de teste para a nuvem após a conclusão.

Para ver o relatório enviado:

Acesse a seção "Test Reports" no painel do Apidog.

Procure a coluna "Team Reports".

Observação: para relatórios enviados via CLI, o campo "Tester" será exibido como vazio.

Usar scripts/programas externos na CLI

Você pode referenciar scripts ou programas externos ao executar a CLI do Apidog adicionando o caminho deles ao final do comando. Veja como fazer isso:

Neste exemplo, a CLI é instruída a referenciar programas localizados no diretório ./scripts. Se nenhuma hierarquia for especificada, o padrão será o diretório atual de execução da CLI.

Há duas abordagens principais para gerenciar esses scripts externos:

1. Caminho local

Para evitar confusão no gerenciamento de scripts locais, recomenda-se:

Organizar todos os arquivos de script por categoria

Colocá-los em um diretório específico

Especificar o caminho local correspondente no comando da CLI

2. Repositório de código na nuvem

Como alternativa, você pode:

Hospedar arquivos de script em um repositório de código baseado em nuvem

Configurar comandos pull no seu fluxo de trabalho de CI/CD para buscar scripts externos para o ambiente local

Especificar o caminho real dos scripts externos no comando da CLI

SSL

Certificado do cliente

A CLI do Apidog oferece suporte à passagem de certificados do cliente.

Usar um único certificado de cliente SSL

--ssl-client-cert
Especifique o caminho do certificado público do cliente SSL.

--ssl-client-key
Especifique o caminho do certificado privado do cliente SSL (opcional).

--ssl-client-passphrase
Especifique a frase secreta do cliente SSL (opcional).

Usar arquivo de configuração de certificados de cliente SSL (compatível com vários certificados)

--ssl-client-cert-list
Especifique o caminho do arquivo JSON da lista de certificados de cliente SSL. Por exemplo: ssl-client-cert-list.json

[
    {
        "name": "domain1",
        "matches": ["https://test.domain1.com/*", "https://www.domain1/*"],
        "key": {"src": "/CI/client.domain1.key"},
        "cert": {"src": "/CI/client.domain1.crt"},
        "passphrase": "changeme"
    },
    {
        "name": "domain2",
        "matches": ["https://domain2.com/*"],
        "key": {"src": "/CI/client.domain2.key"},
        "cert": {"src": "/CI/client.domain2.crt"},
        "passphrase": "changeme"
    }
]

Esta opção oferece suporte à definição de diferentes certificados de cliente SSL com base na URL ou no nome do host. Ela tem precedência sobre as opções --ssl-client-cert, --ssl-client-key e --ssl-client-passphrase. Essas opções serão usadas como opções de fallback se não houver correspondência para a URL na lista.

HTTP/2

A CLI pode ser configurada para usar versões específicas de protocolo para enviar requisições usando o parâmetro --preferred-http-version.

Valores do parâmetro de versão do protocolo:

"HTTP/2" - HTTP/2 Application-Layer Protocol Negotiation (ALPN), compatível apenas com requisições HTTPS.

"HTTP/2-with-prior-knowledge" - HTTP/2 com conhecimento prévio.

"HTTP/1" - HTTP/1.1.

O parâmetro oferece suporte às seguintes configurações:

Definir versões de protocolo diferentes para requisições HTTPS e HTTP:

Definir a mesma versão de protocolo para HTTPS e HTTP:

Definir HTTP/2 para HTTPS e HTTP (valores não compatíveis serão ignorados automaticamente):

FAQ

Como lidar com a mensagem de erro Invalid character in header content['Authorization']?

Esse erro geralmente é causado por caracteres inválidos no cabeçalho Authorization, como caracteres não ASCII, quebras de linha ou espaços extras. Se você tiver certeza de que a execução de cenários de teste no cliente Apidog ou na interface web não produz erros, verifique se você definiu valores INITIAL para variáveis no seu ambiente e confirme se o valor Authorization corresponde ao formato esperado.

Como posso editar dados do projeto diretamente sem usar uma branch de IA?

As permissões de gravação do projeto podem ser restritas por segurança. Verifique as configurações de recursos do projeto e habilite permissões de edição externa quando a edição direta for necessária.

Opções da CLI do Apidog

Sintaxe básica da CLI do Apidog#

Autenticação#

Esquema da CLI#

Equipes e projetos#

Gerenciamento de equipes#

Gerenciamento de projetos#

Configurações do projeto#

Ambientes e variáveis#

Gerenciamento de ambientes#

Gerenciamento de variáveis#

Recursos de design de API#

Endpoints de API HTTP#

Esquemas de dados#

Documentos Markdown#

Pastas de recursos#

Regras de mock#

Parâmetros comuns#

Componentes de resposta#

Esquemas de segurança#

Testes automatizados#

Casos de teste de API#

Cenários de teste#

Suítes de teste#

Dados de teste#

Relatórios de teste#

Runners#

Tarefas agendadas#

Comando principal de execução: apidog run#

Execução online#

Execução local#

Opções de execução#

Importação e exportação#

Importar dados do projeto#

Configurações de importação automática#

Exportar dados do projeto#

Configurações de exportação OAS#

Compartilhamento de documentação#

Sites de documentação#

Documentos compartilhados#

Gerenciamento de branches#

Branches de iteração#

Branches de IA#

Branches gerais#

Solicitações de merge#

Outros recursos#

Campos personalizados#

APIs WebSocket#

APIs Socket.IO#

Scripts comuns#

Conexões de banco de dados#

Provedores de cofre#

Conexões Git#

Gerenciamento e configurações#

Notificações#

Lixeira#

Histórico#

Logs de auditoria#

Uso avançado#

Upload de arquivos na CLI#

Usar operações de banco de dados na CLI#

Enviar relatórios de teste locais da CLI para a nuvem#

Usar scripts/programas externos na CLI#

1. Caminho local#

2. Repositório de código na nuvem#

SSL#

Certificado do cliente#

Usar um único certificado de cliente SSL#

Usar arquivo de configuração de certificados de cliente SSL (compatível com vários certificados)#

HTTP/2#

FAQ#

Sintaxe básica da CLI do Apidog

Autenticação

Esquema da CLI

Equipes e projetos

Gerenciamento de equipes

Gerenciamento de projetos

Configurações do projeto

Ambientes e variáveis

Gerenciamento de ambientes

Gerenciamento de variáveis

Recursos de design de API

Endpoints de API HTTP

Esquemas de dados

Documentos Markdown

Pastas de recursos

Regras de mock

Parâmetros comuns

Componentes de resposta

Esquemas de segurança

Testes automatizados

Casos de teste de API

Cenários de teste

Suítes de teste

Dados de teste

Relatórios de teste

Runners

Tarefas agendadas

Comando principal de execução: `apidog run`

Execução online

Execução local

Opções de execução

Importação e exportação

Importar dados do projeto

Configurações de importação automática

Exportar dados do projeto

Configurações de exportação OAS

Compartilhamento de documentação

Sites de documentação

Documentos compartilhados

Gerenciamento de branches

Branches de iteração

Branches de IA

Branches gerais

Solicitações de merge

Outros recursos

Campos personalizados

APIs WebSocket

APIs Socket.IO

Scripts comuns

Conexões de banco de dados

Provedores de cofre

Conexões Git

Gerenciamento e configurações

Notificações

Lixeira

Histórico

Logs de auditoria

Uso avançado

Upload de arquivos na CLI

Usar operações de banco de dados na CLI

Enviar relatórios de teste locais da CLI para a nuvem

Usar scripts/programas externos na CLI

1. Caminho local

2. Repositório de código na nuvem

SSL

Certificado do cliente

Usar um único certificado de cliente SSL

Usar arquivo de configuração de certificados de cliente SSL (compatível com vários certificados)

HTTP/2

FAQ