DEV Community

Cover image for Como Migrar de inso (Insomnia CLI) para Apidog CLI
Lucas
Lucas

Posted on • Originally published at apidog.com

Como Migrar de inso (Insomnia CLI) para Apidog CLI

Se você executa testes de API com o inso, o CLI do Insomnia da Kong, e quer migrar para o Apidog CLI, use este guia como checklist prático. Você vai exportar especificações e coleções do Insomnia, importá-las no Apidog e substituir comandos inso run por apidog run no seu ambiente local e no CI.

Experimente o Apidog hoje

Por que migrar do inso para o Apidog CLI

O inso é uma ferramenta sólida para executar requisições, testes e linting Spectral a partir do terminal. Ele lê dados de um diretório .insomnia, normalmente criado pelo Git Sync do Insomnia.

A migração costuma acontecer por três motivos:

  • Conta na nuvem obrigatória no Insomnia 8+: muitas equipes que preferiam um fluxo local-first passaram a depender de login.
  • Risco de perda de dados ou problemas de migração: se você passou por isso, veja os guias de recuperação e exportação de dados do Insomnia e recuperação/migração após perda de dados no Insomnia 8.
  • Consolidação da stack: com inso, você normalmente combina Insomnia, Spectral, ferramentas de mock, documentação e CI. O Apidog reúne design, depuração, testes, mocks e documentação em uma plataforma, com execução via CLI.

Se quiser comparar as ferramentas antes de migrar, veja também Apidog vs Insomnia e como escolher entre Insomnia e Apidog.

Antes de começar: o que migra e o que precisa ser recriado

Ativo no Insomnia Migra para o Apidog? Como
OpenAPI / documentos de design Sim Exportar para YAML/JSON e importar no Apidog
Coleções de requisições Sim Exportar no Insomnia e importar no Apidog
Ambientes e variáveis Sim Recriar como ambientes no Apidog
Suítes de teste de unidade (inso run test) Parcialmente Reconstruir como cenários de teste no Apidog
Configuração de lint Spectral (inso lint spec) Não 1:1 Manter Spectral no CI, se necessário

Ponto importante: inso lint spec executa o Spectral, o linter OpenAPI da Stoplight. O Apidog CLI não oferece um comando autônomo equivalente para lint, style guide, split, join ou bundle.

O Apidog valida sua especificação ao importá-la. Isso ajuda a encontrar problemas estruturais, mas não substitui regras Spectral customizadas. Se seu pipeline depende de Spectral como gate de qualidade, mantenha Spectral no CI junto com apidog run.

Passo 1: exporte suas especificações do Insomnia

Para exportar um documento OpenAPI pelo inso, use o nome do design exibido no Insomnia:

# Exporta um documento OpenAPI para YAML
inso export spec "My API Design" --output my-api.yaml
Enter fullscreen mode Exit fullscreen mode

Se o inso não encontrar os dados, informe o diretório correto com --workingDir ou --src:

inso export spec "My API Design" \
  --workingDir ./design \
  --output my-api.yaml
Enter fullscreen mode Exit fullscreen mode

Para coleções de requisições ou itens que não forem exportados corretamente pelo CLI, use o aplicativo Insomnia:

  1. Abra o workspace no Insomnia.
  2. Acesse a opção de exportação.
  3. Exporte como OpenAPI ou Insomnia v4.
  4. Salve separadamente:
    • o documento de design;
    • a coleção de requisições;
    • referências de ambientes/variáveis.

Se você estiver recuperando dados após problema de sync, login ou migração, siga o guia de recuperação e exportação antes de importar no Apidog.

Passo 2: importe os arquivos no Apidog

Abra o Apidog, crie um projeto e importe o YAML ou JSON exportado.

Fluxo recomendado:

  1. Crie um novo projeto no Apidog.
  2. Importe o arquivo OpenAPI.
  3. Verifique endpoints, schemas e exemplos.
  4. Recrie os ambientes usados no Insomnia, como dev, staging e ci.
  5. Importe coleções adicionais, se necessário.
  6. Reconstrua suas suítes como cenários de teste.

O Apidog lê OpenAPI nativamente. Na importação, ele valida a especificação e aponta problemas estruturais. Isso não substitui o Spectral, mas ajuda a corrigir erros antes de executar testes.

Você também pode usar o CLI em fluxos automatizados. Para configurar autenticação e instalação, veja:

Passo 3: mapeie comandos inso para apidog run

Use esta tabela para atualizar seus scripts locais, package.json, Makefiles ou workflows de CI.

Objetivo Comando inso Equivalente no Apidog CLI
Executar uma suíte de teste inso run test "Smoke Suite" --env "Staging" apidog run --test-scenario "Smoke Suite" -e staging
Executar uma coleção inso run collection "Checkout Flow" --env "Staging" apidog run "Checkout Flow" -e staging
Executar via script nomeado inso script ci-smoke --env <env-id> apidog run -e <env-id> dentro do seu script de CI
Fazer lint de OpenAPI inso lint spec "My API Design" Não há 1:1; o Apidog valida na importação
Exportar especificação inso export spec "My API Design" --output api.yaml Use importação/exportação do Apidog; não é uma etapa de runtime

Ambientes

No inso, você usava:

inso run test "Smoke Suite" --env "Staging"
Enter fullscreen mode Exit fullscreen mode

No Apidog CLI, use -e ou --env:

apidog run --test-scenario "Smoke Suite" -e staging
Enter fullscreen mode Exit fullscreen mode

Antes de rodar o comando, recrie no Apidog as variáveis usadas no Insomnia, por exemplo:

base_url=https://staging.example.com
token={{auth_token}}
Enter fullscreen mode Exit fullscreen mode

Suítes de teste viram cenários de teste

No Insomnia, inso run test executa suítes de teste. No Apidog, o equivalente prático é um cenário de teste: uma sequência ordenada de requisições com asserções.

Exemplo de estrutura:

Smoke Suite
├── POST /auth/login
│   └── salvar token em variável
├── GET /me
│   └── validar status 200
└── GET /orders
    └── validar que a resposta contém uma lista
Enter fullscreen mode Exit fullscreen mode

Depois de reconstruir esse fluxo no Apidog, você executa com:

apidog run --test-scenario "Smoke Suite" -e staging
Enter fullscreen mode Exit fullscreen mode

Para uma comparação mais detalhada, veja Apidog CLI vs inso. Se você também usa Newman ou Postman CLI, consulte Apidog CLI vs Newman e Apidog CLI vs Postman CLI.

Passo 4: configure relatórios

O inso costuma ser usado com saída no terminal e relatórios JUnit. No Apidog CLI, você pode gerar relatórios em formatos como CLI, HTML e JSON.

Exemplo:

# Executa um cenário e gera resumo no terminal + relatório HTML
apidog run --test-scenario "Smoke Suite" \
  -e staging \
  -r cli,html
Enter fullscreen mode Exit fullscreen mode

Use:

  • cli para leitura rápida nos logs;
  • html para revisão manual;
  • json para ferramentas que processam resultados;
  • --upload-report para enviar resultados aos relatórios de teste na nuvem do Apidog.

Exemplo para CI:

apidog run --test-scenario "Smoke Suite" \
  -e ci \
  -r cli,json \
  --upload-report
Enter fullscreen mode Exit fullscreen mode

Veja mais no guia de relatórios de teste do Apidog CLI.

Passo 5: migre testes orientados a dados

Se suas suítes no Insomnia executavam os mesmos requests com diferentes entradas, use datasets no Apidog CLI.

Com CSV:

apidog run --test-scenario "Login Matrix" \
  -e staging \
  -d ./users.csv \
  -r cli,json
Enter fullscreen mode Exit fullscreen mode

Exemplo de users.csv:

email,password,expected_status
user1@example.com,correct-password,200
user2@example.com,wrong-password,401
Enter fullscreen mode Exit fullscreen mode

Com JSON:

apidog run --test-scenario "Login Matrix" \
  -e staging \
  -d ./users.json \
  -r cli,json
Enter fullscreen mode Exit fullscreen mode

Exemplo de users.json:

[
  {
    "email": "user1@example.com",
    "password": "correct-password",
    "expected_status": 200
  },
  {
    "email": "user2@example.com",
    "password": "wrong-password",
    "expected_status": 401
  }
]
Enter fullscreen mode Exit fullscreen mode

O guia de testes orientados a dados explica os formatos e a vinculação de variáveis.

Passo 6: atualize seu CI

Se seu pipeline hoje usa inso, ele provavelmente tem algo parecido com isto:

# Antes: inso no CI
inso run test "Smoke Suite" --env "CI" --reporter junit
Enter fullscreen mode Exit fullscreen mode

Troque por:

# Depois: Apidog CLI no CI
apidog run --test-scenario "Smoke Suite" \
  -e ci \
  -r cli,json \
  --upload-report
Enter fullscreen mode Exit fullscreen mode

Checklist para CI:

  1. Instale o Apidog CLI no runner.
  2. Configure autenticação com token de acesso.
  3. Armazene o token como segredo do CI.
  4. Recrie o ambiente ci no Apidog.
  5. Execute apidog run.
  6. Publique o relatório como artefato, se necessário.

Consulte:

Mantendo o Spectral no pipeline

Se você usava inso lint spec com regras customizadas, mantenha o Spectral. O Apidog CLI não substitui esse papel.

Pipeline híbrido típico:

# Lint OpenAPI com Spectral
npx @stoplight/spectral-cli lint my-api.yaml

# Executa testes com Apidog CLI
apidog run --test-scenario "Smoke Suite" \
  -e ci \
  -r cli,json
Enter fullscreen mode Exit fullscreen mode

Esse modelo separa responsabilidades:

  • Spectral valida estilo e regras OpenAPI customizadas.
  • Apidog executa cenários de teste, ambientes e relatórios.

Visão geral: inso vs Apidog CLI

Capacidade inso / Insomnia CLI Apidog CLI
Executar coleções/suítes Sim Sim
Ambientes --env -e / --env
Lint OpenAPI Sim, via Spectral Sem comando autônomo; valida na importação
Testes orientados a dados Limitado Sim, com -d para CSV/JSON
Relatórios CLI, JUnit CLI, HTML, JSON, upload para nuvem
Recurso como código Lê diretório .insomnia Endpoints, schemas, branches e merge requests
Plataforma unificada Insomnia + ferramentas externas Design, mock, docs e test
Conta necessária no app Sim no Insomnia 8+ Conta Apidog, com fluxo amigável ao local

FAQ

Minha especificação OpenAPI do Insomnia será importada no Apidog sem edições?

Geralmente sim. O Apidog lê OpenAPI nativamente e valida a especificação na importação. Se algo falhar, normalmente é um problema estrutural da própria especificação.

O Apidog CLI tem um comando lint como inso lint spec?

Não. O Apidog valida especificações na importação, mas não possui um linter CLI autônomo nem um comando de style guide. Se você usa regras Spectral customizadas, mantenha o Spectral no CI. Para comparar com uma ferramenta que inclui linter, veja Apidog CLI vs Redocly CLI.

Posso executar o Apidog CLI no CI como fazia com inso?

Sim. Substitua o comando, autentique o runner com token de acesso e escolha os formatos de relatório. O guia de CI/CD tem exemplos completos.

O que acontece com minhas suítes de teste do Insomnia?

Você as reconstrói como cenários de teste do Apidog. A estrutura é parecida: requisições ordenadas, variáveis, dependências entre etapas e asserções.

Estou migrando por causa de perda de dados no Insomnia. Por onde começo?

Recupere e exporte seus dados primeiro usando o guia de recuperação e exportação. Depois importe o arquivo limpo no Apidog e recrie os cenários de teste.

Conclusão

Migrar de inso para Apidog CLI é principalmente uma troca de fluxo:

  1. Exporte especificações e coleções do Insomnia.
  2. Importe OpenAPI/JSON no Apidog.
  3. Recrie ambientes e variáveis.
  4. Transforme suítes do Insomnia em cenários de teste.
  5. Substitua inso run test e inso run collection por apidog run.
  6. Atualize relatórios e autenticação no CI.
  7. Mantenha Spectral se você depende de linting OpenAPI customizado.

A principal mudança é sair de uma pilha com várias ferramentas conectadas manualmente para uma plataforma única de design, mock, documentação e testes. Para começar, baixe o Apidog e execute seu primeiro apidog run contra a especificação exportada.

Top comments (0)