Apidog CLI lleva tiempo siendo el punto de entrada de línea de comandos para ejecutar pruebas de API desde una terminal, un pipeline de CI, un flujo de automatización o un sistema externo.
apidog run --project <projectId> --test-scenario <scenarioId> --environment <environmentId>
Esa base sigue siendo clave: los equipos necesitan ejecutar pruebas de API de forma fiable, generar informes y mantener puertas de calidad dentro de CI. Pero el desarrollo de APIs está cambiando. Los Agentes de IA ya participan en diseño, generación de pruebas, depuración, migración y mantenimiento.
Para esos flujos, una CLI no puede limitarse a ejecutar pruebas al final. También debe permitir que scripts y Agentes lean activos de API, creen o actualicen pruebas, validen cambios estructurados, los escriban de nuevo y verifiquen el resultado.
La Apidog CLI actualizada mantiene la ejecución de pruebas y la amplía como una capa de flujo de trabajo para desarrolladores, automatización y Agentes de IA. En esta guía verás qué cambió y cómo usarla en flujos reales de pruebas de API.
Por qué la CLI es más importante en la era de los Agentes de IA
Las interfaces gráficas están diseñadas para personas: exploración visual, colaboración y revisión. Los Agentes de IA, en cambio, funcionan mejor con:
- Comandos estructurados.
- Entradas predecibles.
- Salidas parseables.
- Validación explícita.
- Pasos repetibles.
Ahí es donde una CLI aporta valor. Apidog CLI ofrece una interfaz repetible sobre los mismos recursos que los equipos gestionan en Apidog:
- APIs.
- Entornos.
- Variables.
- Casos de prueba.
- Escenarios de prueba.
- Suites.
- Informes.
- Importaciones y exportaciones.
- Recursos de proyecto.
En la práctica, las personas pueden seguir diseñando, depurando y revisando en la UI, mientras que scripts y Agentes usan la CLI para operar sobre esos mismos activos de forma controlada.
De apidog run a flujos completos de API y pruebas
La experiencia anterior de CLI estaba centrada principalmente en ejecutar pruebas. Eso hacía que apidog run fuera útil como puerta de calidad en CI, pero normalmente aparecía al final del flujo.
La CLI actualizada amplía la cobertura a recursos centrales de Apidog, lo que permite automatizar pasos anteriores: leer contexto del proyecto, preparar pruebas, validar cambios estructurados y luego ejecutar la verificación.
Con la CLI actualizada puedes trabajar con recursos como:
- Proyectos y metadatos.
- APIs y definiciones de API.
- Entornos y variables.
- Casos de prueba.
- Escenarios de prueba.
- Suites de prueba.
- Informes.
- Flujos de importación y exportación.
- Cuentas, ramas, ejecutores y recursos relacionados.
Esto cambia el rol de Apidog CLI: ya no es solo el comando que ejecuta pruebas cuando todo está terminado. Ahora puede participar antes en el ciclo de desarrollo, especialmente cuando un Agente necesita comprender el proyecto, generar o actualizar activos de prueba y validar el resultado.
Un ciclo más seguro para pruebas impulsadas por Agentes
Cuando un Agente de IA ayuda con APIs, el riesgo no está solo en generar contenido. El riesgo real aparece cuando ese contenido se escribe en un proyecto real sin estructura ni verificación suficiente.
Un ciclo más seguro es:
- Leer el recurso existente.
- Generar o modificar contenido.
- Validar la estructura.
- Escribir el cambio.
- Leer el recurso guardado.
- Ejecutar pruebas cuando corresponda.
Este ciclo importa porque muchos recursos de Apidog son estructurados. Un caso o escenario de prueba puede incluir:
- Datos de request.
- Aserciones.
- Extracción de variables.
- Pre-procesadores.
- Post-procesadores.
- Orden de pasos.
- Referencias a entornos.
- Configuración adicional de ejecución.
Si un Agente adivina la estructura, pequeños errores pueden causar escrituras fallidas, visualización incompleta en la UI o pruebas que no se comportan como se esperaba.
Para eso sirve cli-schema. Antes de escribir un JSON complejo en Apidog, el Agente puede pedir a la CLI que valide si los campos y la estructura coinciden con el esquema esperado.
apidog cli-schema validate test-case-create --file ./test-case-create.json
apidog cli-schema validate test-scenario-update --file ./scenario-update.json
Regla práctica:
Deja que el Agente genere, pero deja que la CLI valide antes de escribir.
La CLI también puede devolver sugerencias orientadas al Agente. Después de crear o actualizar un recurso, el siguiente paso no debería ser detenerse. Un flujo más fiable es leer el recurso guardado, confirmar la estructura y ejecutar pruebas cuando aplique.
Las Habilidades dan juicio operativo a los Agentes
Los comandos de CLI dan capacidad de ejecución. Las Habilidades dan criterio operativo.
Una HABILIDAD no es solo una referencia de comandos. Es una guía para Agentes de IA sobre:
- Cuándo usar cada comando.
- Qué comando debe ejecutarse primero.
- Qué campos no deben adivinarse.
- Cuándo validar.
- Cuándo volver a leer el recurso.
- Cuándo ejecutar pruebas.
Por ejemplo, un Agente fiable no debería crear siempre un escenario grande desde cero. Un patrón más seguro suele ser:
- Crear el escenario base.
- Importar pasos desde APIs o casos existentes.
- Leer la estructura completa del escenario.
- Actualizar aserciones, variables o procesadores en cambios pequeños.
- Validar y ejecutar el escenario.
Las Habilidades hacen explícitos estos patrones y ayudan a evitar errores comunes:
- Usar un nombre de campo incorrecto.
- Elegir un valor enumerado inválido.
- Omitir validación de esquema.
- Asumir que una escritura exitosa significa que el recurso final es correcto.
Apidog proporciona 8 Habilidades complementarias para ayudar a los Agentes a entender comandos de CLI, estructuras de recursos y flujos de trabajo. Juntas, la CLI y las Habilidades hacen que Apidog sea más práctico para desarrollo y pruebas de API asistidos por IA.
Cambios de proyecto más seguros con Ramas de IA
Cuando un Agente modifica recursos de un proyecto, la seguridad y la revisión son críticas. Por eso, la CLI actualizada también se puede usar junto con las Ramas de IA.
Un flujo recomendado es:
- Crear o usar una rama aislada.
- Permitir que el Agente haga cambios en esa rama.
- Revisar diferencias.
- Confirmar el resultado.
- Fusionar en la rama de destino.
Esto evita que cambios automatizados afecten directamente la rama principal o una rama compartida de colaboración.
Qué desbloquea en flujos reales
El valor de la CLI actualizada se ve mejor en tareas concretas.
Generar pruebas desde definiciones de API
Un flujo controlado para generación de pruebas puede ser:
- Leer definiciones de API desde el proyecto.
- Generar casos de prueba.
- Validar el JSON generado con
cli-schema. - Escribir los casos en Apidog.
- Leerlos de nuevo.
- Ejecutar la verificación.
Así, la generación de pruebas deja de ser una sugerencia puntual y se convierte en un flujo repetible.
Mantener escenarios de prueba complejos
Para escenarios de múltiples pasos, evita crear todo en una sola pasada. Un enfoque más seguro es importar pasos existentes y luego ajustar detalles.
apidog test-scenario import-steps <scenarioId> --project <projectId> --source endpoint --ids <endpointIds> --sync manual
apidog test-scenario get <scenarioId> --project <projectId> --with-case-detail
Después de leer la estructura completa, el Agente puede actualizar:
- Aserciones.
- Variables extraídas.
- Pre-procesadores.
- Post-procesadores.
- Orden o configuración de pasos.
Esto reduce el riesgo de construir un escenario grande con una estructura incorrecta.
Mover y reproducir activos de proyecto
La CLI también mejora flujos de importación y exportación de datos nativos de Apidog. Esto es útil para:
- Migración de proyectos.
- Reproducción de entornos de clientes.
- Copia de configuraciones de prueba.
- Movimiento de APIs, esquemas, casos y escenarios entre proyectos.
apidog export --project <projectId> --format apidog --output ./project.apidog.json
apidog import --project <projectId> --format apidog --file ./project.apidog.json
Mantener puertas de calidad en CI
Las capacidades preparadas para Agentes no reemplazan CI. La complementan.
Puedes seguir usando apidog run como punto de entrada para ejecutar pruebas automatizadas y generar informes.
apidog run --project <projectId> --test-scenario <scenarioId> --environment <environmentId> -r "cli,html,junit" --out-dir ./apidog-reports
Este patrón encaja bien en pipelines donde necesitas:
- Ejecutar pruebas de API.
- Generar salida CLI.
- Exportar reportes HTML.
- Publicar resultados JUnit.
- Bloquear merges si falla la calidad.
Primeros pasos
Si ya tienes Apidog CLI instalado, comprueba la versión:
apidog -v
Si tu versión de Apidog CLI es anterior a la 2.2.5, actualiza antes de usar las nuevas capacidades. Este número se refiere a Apidog CLI, no a la aplicación Apidog.
Puedes pedir a tu Agente de IA que instale Apidog CLI y las Habilidades complementarias copiando este mensaje:
Read the instructions and help me install Apidog CLI:
https://apidog.com/apidog-cli-installation-guide.md?utm_source=dev.to&utm_medium=wanda&utm_content=n8n-post-automation
Si prefieres instalar o actualizar manualmente:
npm install -g apidog-cli@latest
Para la referencia completa de comandos, consulta Opciones de Apidog CLI.
Prueba tu primera tarea de Agente
Después de instalar la CLI y las Habilidades, empieza con una tarea pequeña y de bajo riesgo.
Por ejemplo: pedir al Agente que cree un endpoint simple GET /health en un proyecto de Apidog y luego lo lea de nuevo para confirmar el resultado.
Copia este prompt en tu 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.
Este prompt fuerza un flujo seguro:
- Verificar la configuración de CLI.
- Listar proyectos disponibles.
- Pedir confirmación antes de escribir.
- Crear una definición pequeña.
- Validar entrada estructurada.
- Leer el endpoint creado.
- Resumir el resultado guardado.
Próximos pasos:
- Descarga Apidog para diseñar, depurar, probar y documentar APIs en un solo espacio de trabajo.
- Obtén más información sobre Apidog CLI para pruebas de API en línea de comandos, automatización de CI y flujos de trabajo con Agentes de IA.
Preguntas frecuentes
¿Qué es Apidog CLI?
Apidog CLI es una herramienta de línea de comandos para ejecutar pruebas de API, trabajar con recursos de proyectos de Apidog y conectar activos de API y pruebas con flujos de automatización.
¿Puede Apidog CLI ejecutar pruebas de API en CI?
Sí. Los equipos pueden usar apidog run en pipelines de CI para ejecutar pruebas de API, generar informes y mantener puertas de calidad automatizadas.
¿Cómo ayuda Apidog CLI a los Agentes de IA?
Apidog CLI proporciona a los Agentes de IA una forma estructurada de leer información de API, generar o actualizar activos de prueba, validar cambios, escribirlos en Apidog, leer el resultado y ejecutar pruebas para verificarlo.
¿Qué es cli-schema en Apidog CLI?
cli-schema permite validar archivos JSON complejos antes de escribirlos en Apidog. Esto reduce escrituras fallidas, campos inválidos y bucles de reintento innecesarios cuando los Agentes crean o actualizan casos y escenarios de prueba.
¿Cómo instalo Apidog CLI?
Puedes pedir a un Agente de IA que siga la guía de instalación de Apidog CLI e instale tanto la CLI como las Habilidades complementarias, o instalarla manualmente con:
bash
npm install -g apidog-cli@latest
Top comments (0)