DEV Community

Cover image for Cómo migrar de inso (Insomnia CLI) a Apidog CLI
Roobia
Roobia

Posted on • Originally published at apidog.com

Cómo migrar de inso (Insomnia CLI) a Apidog CLI

Si ejecutas pruebas de API con inso, la CLI de Insomnia de Kong, y quieres migrar a Apidog CLI, usa esta guía como checklist de implementación. Vas a exportar especificaciones y colecciones desde Insomnia, importarlas en Apidog, reconstruir suites como escenarios de prueba y reemplazar comandos inso run por apidog run en CI.

Prueba Apidog hoy

Por qué migrar de inso a Apidog CLI

inso es una CLI sólida para ejecutar requests, pruebas unitarias y linting de OpenAPI con Spectral desde proyectos de Insomnia. Si tu flujo actual funciona, no necesitas cambiarlo.

La migración suele aparecer por tres motivos prácticos:

  • Cuenta en la nube requerida en Insomnia 8+. Algunos equipos preferían un cliente local-first y encontraron una barrera adicional de login.
  • Incidentes de datos o migración. Si estás recuperando datos, revisa estas guías: recuperación y exportación de datos de Insomnia y recuperación de pérdida de datos y migración de Insomnia 8.
  • Consolidación del stack. Con inso, normalmente combinas Insomnia, Spectral y otras herramientas para mocks, documentación o pruebas. Apidog centraliza diseño, depuración, pruebas, mocks y documentación; su CLI ejecuta la parte de pruebas de esa plataforma.

Si necesitas comparar las aplicaciones completas antes de migrar, revisa Apidog vs Insomnia y elegir entre Insomnia y Apidog.

Antes de empezar: qué se migra y qué no

Usa esta tabla para planificar el alcance real de la migración.

Activo en Insomnia ¿Se migra a Apidog? Cómo
Documentos OpenAPI / de diseño Sí Exportar a YAML/JSON e importar a Apidog
Colecciones de solicitudes Sí Exportar desde Insomnia e importar en Apidog
Entornos y variables Sí Recrear como entornos de Apidog
Conjuntos de pruebas unitarias (inso run test) Parcialmente Reconstruir como escenarios de prueba de Apidog
Configuración de lint de Spectral (inso lint spec) No 1:1 Mantener Spectral en CI si usas reglas personalizadas

Nota importante: inso lint spec ejecuta Spectral, el linter de OpenAPI de Stoplight. Apidog CLI no incluye un linter de especificaciones independiente, una guía de estilo, ni comandos de división, unión o empaquetado.

Apidog valida la especificación al importarla. Eso ayuda a detectar problemas estructurales, pero no reemplaza un conjunto de reglas personalizado de Spectral. Si tu pipeline depende de Spectral, mantenlo junto con apidog run.

Paso 1: exporta especificaciones y colecciones desde Insomnia

Primero exporta tu documento OpenAPI. El nombre debe coincidir con el documento de diseño que ves en Insomnia.

# Exportar un documento OpenAPI a YAML
inso export spec "My API Design" --output my-api.yaml
Enter fullscreen mode Exit fullscreen mode

Si inso no encuentra los datos, apunta al directorio correcto. Por defecto, lee desde .insomnia en el directorio actual o desde el directorio de datos de la app de Insomnia.

# Usar un directorio de trabajo específico
inso export spec "My API Design" \
  --workingDir ./design \
  --output my-api.yaml
Enter fullscreen mode Exit fullscreen mode

Para colecciones de solicitudes o recursos que inso no exporte correctamente:

  1. Abre Insomnia.
  2. Selecciona el workspace.
  3. Usa Exportar.
  4. Guarda el archivo como OpenAPI o Insomnia v4.
  5. Conserva por separado:
    • especificación OpenAPI;
    • colección exportada;
    • datos de entorno si los usas.

Si estás recuperando datos después de un problema con Git Sync o cuenta cloud, sigue la guía de exportación y recuperación.

Paso 2: importa el proyecto en Apidog

Abre Apidog, crea un proyecto e importa el YAML o JSON exportado.

Apidog lee OpenAPI de forma nativa, por lo que los endpoints, esquemas y ejemplos quedan disponibles como recursos editables para probar, simular y documentar.

Flujo recomendado:

  1. Crea un proyecto en Apidog.
  2. Importa my-api.yaml o my-api.json.
  3. Revisa errores de validación.
  4. Importa la colección exportada si la tienes separada.
  5. Recrea los entornos de Insomnia como entornos de Apidog.
  6. Verifica variables como:
    • base_url;
    • tokens;
    • headers comunes;
    • credenciales de test.

También puedes importar como parte de una configuración automatizada usando Apidog CLI. Esto es útil si migras varios proyectos o equipos. Para instalar y autenticar la CLI, revisa la guía de instalación de Apidog CLI y la guía completa de la CLI.

Recuerda: la validación al importar no equivale a inso lint spec. Si necesitas reglas de estilo o reglas personalizadas, mantén Spectral.

Paso 3: reemplaza comandos inso por apidog run

Esta tabla cubre el mapeo principal para tus scripts locales y de CI.

Objetivo Comando con inso Equivalente en Apidog CLI
Ejecutar un conjunto de pruebas unitarias inso run test "Smoke Suite" --env "Staging" apidog run --test-scenario "Smoke Suite" -e staging
Ejecutar una colección inso run collection "Checkout Flow" --env "Staging" apidog run "Checkout Flow" -e staging
Ejecutar un script nombrado inso script ci-smoke --env <env-id> apidog run -e <env-id> dentro de tu script CI
Lint de una especificación OpenAPI inso lint spec "My API Design" No hay equivalente 1:1; Apidog valida al importar
Exportar una especificación a archivo inso export spec "My API Design" --output api.yaml Usar importación/exportación de Apidog; no suele ser un paso de runtime

Puntos clave del mapeo:

  • Entornos: inso usa --env. Apidog usa -e o --env.
  • Suites de pruebas: inso run test se convierte en escenarios de prueba de Apidog.
  • Colecciones: si ejecutabas una colección completa, usa apidog run "Nombre de colección".
  • Scripts nombrados: si usabas inso script, mueve la lógica a npm scripts, Makefile, GitHub Actions o GitLab CI.

Ejemplo con package.json:

{
  "scripts": {
    "test:api:smoke": "apidog run --test-scenario \"Smoke Suite\" -e staging -r cli,json",
    "test:api:ci": "apidog run --test-scenario \"Smoke Suite\" -e ci -r cli,json --upload-report"
  }
}
Enter fullscreen mode Exit fullscreen mode

Luego ejecútalo así:

npm run test:api:ci
Enter fullscreen mode Exit fullscreen mode

Para una comparación más detallada de flags, revisa Apidog CLI vs inso. Si vienes de Newman o Postman CLI, también puedes consultar Apidog CLI vs Newman y Apidog CLI vs Postman CLI.

Paso 4: reconstruye tus suites como escenarios de prueba

En inso, ejecutabas suites unitarias de Insomnia. En Apidog, el equivalente práctico son los escenarios de prueba.

Checklist para reconstruir una suite:

  1. Crea un escenario de prueba en Apidog.
  2. Añade las solicitudes en el mismo orden que en Insomnia.
  3. Configura variables de entorno.
  4. Añade aserciones por respuesta.
  5. Valida dependencias entre requests, por ejemplo:
    • extraer un token del login;
    • reutilizar un user_id;
    • comprobar estados HTTP;
    • validar campos del JSON.
  6. Ejecuta el escenario localmente con la CLI.

Ejemplo:

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

Cuando funcione localmente, copia el mismo comando al pipeline.

Paso 5: configura reportes

inso suele usarse con salida CLI o reportes tipo JUnit. Apidog CLI permite reportes en formatos CLI, HTML y JSON.

# Ejecutar un escenario y generar salida CLI + HTML
apidog run --test-scenario "Smoke Suite" \
  -e staging \
  -r cli,html
Enter fullscreen mode Exit fullscreen mode

Usa cada formato según el consumidor:

  • cli: salida en consola para logs de CI.
  • json: integración con herramientas posteriores.
  • html: artefacto revisable por humanos.
  • --upload-report: subir resultados a los informes de pruebas en la nube de Apidog.

Ejemplo para CI:

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

La guía de informes de pruebas explica los formatos disponibles.

Paso 6: migra pruebas basadas en datos

Si tus pruebas de Insomnia iteraban sobre múltiples datos de entrada, Apidog admite ejecución basada en datos con CSV o JSON mediante -d.

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

Ejemplo simple de users.csv:

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

La idea es que el escenario se ejecute una vez por fila y use los valores como variables durante la prueba.

Consulta la guía de pruebas basadas en datos para formatos y vinculación de variables.

Paso 7: actualiza tu pipeline CI/CD

Un paso típico con inso podía verse así:

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

El equivalente con Apidog CLI:

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

Autentica el runner con un token de acceso guardado como secreto de CI. El patrón es el mismo que usarías con cualquier credencial sensible:

  • APIDOG_ACCESS_TOKEN
  • APIDOG_PROJECT_ID
  • variables específicas del entorno

Ejemplo conceptual para GitHub Actions:

name: API tests

on:
  pull_request:
  push:
    branches:
      - main

jobs:
  api-tests:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Run Apidog API tests
        env:
          APIDOG_ACCESS_TOKEN: ${{ secrets.APIDOG_ACCESS_TOKEN }}
        run: |
          apidog run --test-scenario "Smoke Suite" \
            -e ci \
            -r cli,json \
            --upload-report
Enter fullscreen mode Exit fullscreen mode

Para workflows completos, revisa la guía de pipeline CI/CD y la guía de GitHub Actions. Para tokens e inicio de sesión, consulta la autenticación de Apidog CLI.

Mantén Spectral si haces linting de OpenAPI

Este es el punto que no debes migrar a ciegas: si inso lint spec era una puerta de calidad en CI, conserva Spectral.

Un pipeline híbrido razonable queda así:

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

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

Así mantienes tus reglas de linting y usas Apidog para la ejecución de pruebas, documentación, mocks y flujo integrado de API.

inso vs Apidog CLI de un vistazo

Capacidad inso / Insomnia CLI Apidog CLI
Ejecutar colecciones o suites Sí Sí
Entornos --env -e / --env
Linting de OpenAPI Sí, con Spectral No hay comando independiente; valida al importar
Pruebas basadas en datos Limitado Sí, con -d para CSV/JSON
Formatos de reporte CLI, JUnit CLI, HTML, JSON, carga en la nube
Recursos como código Lee el directorio .insomnia Endpoints, esquemas, ramas y solicitudes de fusión
Plataforma unificada Insomnia + herramientas externas Diseño, mocks, docs y pruebas en una plataforma
Cuenta cloud requerida para la app Sí en Insomnia 8+ Cuenta Apidog, con flujo local-friendly

Checklist de migración

Usa esta lista para ejecutar la migración sin perder pasos:

[ ] Exportar especificación OpenAPI desde Insomnia
[ ] Exportar colecciones necesarias
[ ] Guardar variables y entornos actuales
[ ] Crear proyecto en Apidog
[ ] Importar OpenAPI en Apidog
[ ] Importar colección si aplica
[ ] Recrear entornos en Apidog
[ ] Reconstruir suites como escenarios de prueba
[ ] Ejecutar apidog run localmente
[ ] Configurar reportes CLI/JSON/HTML
[ ] Añadir token de Apidog como secreto de CI
[ ] Reemplazar comandos inso en el pipeline
[ ] Mantener Spectral si hay reglas de linting
Enter fullscreen mode Exit fullscreen mode

Preguntas frecuentes

¿Mi especificación OpenAPI de Insomnia se importará en Apidog sin cambios?

Normalmente sí. Apidog lee OpenAPI de forma nativa y valida al importar. Si aparece un error, suele indicar un problema estructural de la especificación.

¿Apidog CLI tiene un comando lint equivalente a inso lint spec?

No. Apidog valida especificaciones al importar, pero no ofrece un linter CLI independiente ni reglas de estilo configurables. Si usas Spectral, mantenlo en CI. Para comparar con una CLI que sí incluye linter, revisa Apidog CLI vs Redocly CLI.

¿Puedo ejecutar Apidog CLI en CI igual que ejecutaba inso?

Sí. Cambia el comando, autentica con un token de acceso guardado como secreto y configura los reporteros necesarios. La guía de CI/CD incluye ejemplos completos.

¿Qué pasa con mis pruebas unitarias de Insomnia?

Debes reconstruirlas como escenarios de prueba de Apidog. El patrón es similar: requests ordenadas, variables y aserciones.

Estoy migrando por pérdida de datos en Insomnia. ¿Por dónde empiezo?

Primero recupera y exporta tus datos con la guía de recuperación y exportación. Luego importa la exportación limpia en Apidog.

Conclusión

Migrar de inso a Apidog CLI es principalmente un cambio de flujo y comandos:

# Antes
inso run test "Smoke Suite" --env "CI"

# Después
apidog run --test-scenario "Smoke Suite" -e ci -r cli,json
Enter fullscreen mode Exit fullscreen mode

Exporta tus especificaciones, impórtalas en Apidog, reconstruye suites como escenarios de prueba y actualiza CI con apidog run. Si tu pipeline usa Spectral, mantenlo para linting y usa Apidog para ejecutar pruebas y centralizar diseño, mocks, documentación y validación funcional.

Para empezar, descarga Apidog y ejecuta tu primer apidog run contra la especificación exportada.

Top comments (0)