Creamos APIs todos los días, y la necesidad de automatización, pruebas y orquestación es primordial. Postman, una herramienta conocida por su interfaz fácil de usar, introdujo su interfaz de línea de comandos (CLI) para admitir una automatización más profunda y flujos de trabajo de CI/CD.
Postman CLI no es solo una herramienta para activar pruebas; es una utilidad expansiva que le permite crear scripts de interacciones de API, integrarse con las canalizaciones existentes y garantizar la integridad de las API en múltiples entornos. Este artículo profundiza en las capacidades avanzadas de Postman CLI, mostrando cómo puede elevar sus prácticas de desarrollo y prueba de API.
La evolución de la CLI de Postman
Antes de sumergirse en los detalles técnicos, es importante comprender por qué Postman introdujo su CLI. La interfaz gráfica de Postman es perfecta para el uso interactivo, ideal para explorar, probar y depurar APIs.
Sin embargo, en un entorno DevOps moderno, la automatización es crucial. Las canalizaciones de Integración Continua/Entrega Continua (CI/CD) requieren pruebas automatizadas y validación de las API, y ahí es donde entra en juego la CLI de Postman. Cierra la brecha entre las pruebas manuales de API y los flujos de trabajo de API totalmente automatizados e integrados. Esta utilidad permite a los equipos ejecutar colecciones, pruebas e integraciones directamente desde una terminal, desbloqueando el potencial de procesos eficientes y repetibles en un entorno automatizado.
¿Cómo instalar y configurar Postman CLI?
Postman CLI no es una herramienta independiente; requiere un entorno configurado, generalmente con una clave de API de Postman para autenticar el acceso a su espacio de trabajo, colecciones y entornos. Esto es fundamental para la ejecución segura y sin problemas de scripts en entornos, especialmente cuando se integra con plataformas CI/CD.
Necesitaremos instalar la CLI para configurarla. Los documentos de Postman tienen una buena guía de documentación que puede ayudar.
Instalación de Windows
Ejecute los siguientes comandos para instalar Postman CLI para Windows. Esto descargará un script de instalación y lo ejecutará. El script de instalación crea un directorio %USERPROFILE%\AppData\Local\Microsoft\WindowsApps si aún no existe, luego instala un binario de postman allí.
powershell.exe -NoProfile -InputFormat None -ExecutionPolicy AllSigned -Command "[System.Net.ServicePointManager]::SecurityProtocol = 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://dl-cli.pstmn.io/install/win64.ps1'))"
Instalación de Mac (Apple silicon)
Ejecute el siguiente comando para instalar Postman CLI para Macs con un procesador Apple silicon. Esto descargará un script de instalación y lo ejecutará. El script de instalación crea un directorio /usr/local/bin si aún no existe, luego instala un binario de postman allí.
curl -o- "https://dl-cli.pstmn.io/install/osx_arm64.sh" | sh
Instalación de Mac (Intel)
Ejecute el siguiente comando para instalar Postman CLI para Macs con chips Intel. Esto descargará un script de instalación y lo ejecutará. El script de instalación crea un directorio /usr/local/bin si aún no existe, luego instala un binario de postman allí.
curl -o- "https://dl-cli.pstmn.io/install/osx_64.sh" | sh
Instalación de Linux
Ejecute el siguiente comando para instalar Postman CLI para la última versión de Linux. Esto descargará un script de instalación y lo ejecutará. El script de instalación crea un directorio /usr/local/bin si aún no existe, luego instala un binario de postman allí.
curl -o- "https://dl-cli.pstmn.io/install/linux64.sh" | sh
Una vez instalado, autentíquese utilizando su clave de API de Postman, que es administrada de forma segura por el backend de Postman:
postman login --with-api-key ABCD-1234-1234-1234-1234-1234
Esta administración de claves de API garantiza que las ejecuciones de CLI tengan el mismo nivel de acceso y seguridad que cualquier sesión en la interfaz web o de escritorio de Postman.
Ejecución de colecciones y entornos
Postman CLI permite la ejecución de colecciones, el corazón de las pruebas de Postman. Las colecciones en Postman representan flujos de trabajo o secuencias de llamadas API que deben probarse. A menudo están vinculadas a entornos, que almacenan variables como URL base, tokens de autenticación o cualquier otro detalle de configuración que varíe entre las etapas de implementación (por ejemplo, desarrollo, ensayo, producción).
Una de las características más avanzadas es la capacidad de ejecutar una colección con un entorno específico. Esto permite que los flujos de API complejos se prueben en múltiples entornos sin modificar la colección en sí:
postman run <collection.json> --environment <environment.json>
Este comando simple pero poderoso permite que múltiples conjuntos de pruebas se ejecuten en diferentes configuraciones, lo que hace que la CLI sea invaluable para orquestar pruebas de API en canalizaciones CI/CD.
Configuración avanzada: variables globales y de entorno
El manejo de variables de Postman CLI es otra característica avanzada. Con la introducción de entornos dinámicos, puede anular y administrar variables globales, de entorno y locales sobre la marcha. Esta capacidad es esencial para flujos de trabajo avanzados donde múltiples parámetros de API deben cambiar dinámicamente en diferentes etapas de prueba.
Considere un escenario donde su API requiere tokens de autenticación dinámicos. En lugar de codificar tokens, puede inyectarlos dinámicamente utilizando Postman CLI:
postman run <collection.json> --env-var token=<new_token>
En escenarios más complejos, es posible que desee cargar estos valores desde archivos externos, administrarlos a través de scripts de pre-solicitud de la colección de Postman o incluso pasarlos como variables de entorno durante el tiempo de ejecución desde su plataforma CI. Esta flexibilidad hace que Postman CLI sea extremadamente potente para manejar flujos de autenticación de API sofisticados.
Ejecución de pruebas e informes personalizados
Postman CLI admite la ejecución de colecciones de Postman que están integradas con pruebas automatizadas, escritas en JavaScript. Estas pruebas pueden verificar la integridad de las respuestas de la API, validar el esquema o comparar los tiempos de respuesta con los umbrales predefinidos.
Al ejecutar colecciones, la CLI proporciona registros e informes detallados. De forma predeterminada, la salida se representa en un formato estructurado que muestra qué pruebas pasaron o fallaron. Sin embargo, Postman CLI va más allá del registro básico. Los usuarios avanzados pueden generar informes personalizados en múltiples formatos, incluidos JSON, HTML y JUnit XML, lo cual es fundamental para la integración con plataformas CI como Jenkins o GitLab:
postman run <collection.json> --reporters cli,json --reporter-json-export output.json
Este comando no solo ejecutará la colección, sino que también generará los resultados en formatos CLI y JSON, lo que permitirá una mayor manipulación o integración con herramientas de panel.
Inmersión profunda: trabajar con Newman vs. Postman CLI
Antes de la introducción de Postman CLI, Newman era la herramienta de referencia para ejecutar colecciones de Postman desde la línea de comandos. Si bien Newman sigue siendo relevante, especialmente para ciertos flujos de trabajo heredados, Postman CLI trae varias mejoras. Se integra directamente con la plataforma en la nube de Postman, ofreciendo una autenticación y administración de entornos más fluidas.
Por ejemplo, Postman CLI puede acceder a espacios de trabajo compartidos directamente desde la nube de Postman, eliminando la necesidad de descargar y administrar colecciones y entornos localmente. También admite mecanismos de autenticación avanzados (OAuth2, tokens de portador, etc.) de forma nativa a través de las configuraciones del espacio de trabajo de Postman, lo que la convierte en una solución más robusta para flujos de trabajo integrados en la nube.
Aquí hay una comparación de una ejecución de colección simple usando Newman y Postman CLI:
Newman:
newman run <collection.json> --environment <environment.json>
Postman CLI:
postman run <collection>
La principal diferencia aquí es la capacidad de Postman CLI para hacer referencia a colecciones y entornos directamente desde el espacio de trabajo de Postman en la nube, lo que lo hace mucho más flexible para entornos con alta seguridad o configuraciones que cambian rápidamente.
Integración de Postman CLI en canalizaciones CI/CD
Una de las principales razones para usar Postman CLI es su integración con canalizaciones CI/CD. En una canalización, las pruebas automatizadas de API se vuelven cruciales para detectar problemas al principio del ciclo de desarrollo. Herramientas como Jenkins, CircleCI, GitLab CI y GitHub Actions pueden invocar comandos de Postman CLI para ejecutar pruebas de API en varias etapas de la canalización.
Considere el siguiente ejemplo para integrar Postman CLI en una canalización de Jenkins:
pipeline {
agent any
stages {
stage('Run Postman Tests') {
steps {
script {
sh 'postman run <collection> --reporters cli,junit --reporter-junit-export results.xml'
}
}
}
}
post {
always {
junit 'results.xml'
}
}
}
Este Jenkinsfile ejecuta la colección de Postman y captura los resultados de las pruebas en un formato compatible con el complemento JUnit de Jenkins, que luego genera informes basados en los resultados de las pruebas.
Postman CLI también permite un control más granular sobre la ejecución de pruebas dentro de las canalizaciones. Por ejemplo, puede definir iteraciones específicas de conjuntos de pruebas, controlar los tiempos de espera y configurar mecanismos de reintento si una prueba falla, proporcionando un entorno de prueba altamente personalizable.
Manejo de fallas y depuración
Las pruebas de API pueden fallar por numerosas razones, que van desde discrepancias en el formato de respuesta hasta errores de configuración del entorno. Postman CLI admite el registro detallado, que es esencial para depurar tales problemas. Usando el indicador --verbose, los desarrolladores pueden acceder a una capa profunda de información, incluidos los cuerpos de solicitud y respuesta, los encabezados y los tiempos de ejecución.
postman run --verbose
Cuando se integra en flujos de trabajo CI/CD, este nivel de granularidad es invaluable. La salida detallada se puede canalizar a los registros que los desarrolladores pueden analizar para determinar si el problema radica en la API en sí, en la configuración de la prueba o en la configuración del entorno.
Explorando Apidog CLI: una experiencia de línea de comandos superior para pruebas automatizadas
Si bien Postman CLI es popular para automatizar los flujos de trabajo de API, Apidog CLI es una alternativa convincente que ofrece un enfoque robusto y flexible para las pruebas automatizadas, creado específicamente para optimizar la ejecución de escenarios de API desde la línea de comandos. Apidog, un competidor de Postman, ofrece una experiencia de prueba de API fluida y basada en comandos, diseñada para desarrolladores que necesitan una solución rápida y automatizada para probar flujos de trabajo complejos en entornos CI/CD.
¿Por qué Apidog CLI?
La CLI de Apidog proporciona todas las capacidades que necesita para automatizar las pruebas de API, con un enfoque particular en la facilidad de uso, las opciones de configuración avanzadas y las potentes capacidades de integración. Está diseñado para ejecutar escenarios de prueba de Apidog desde la terminal, lo que lo convierte en una excelente opción para los equipos que desean integrar las pruebas de API directamente en sus flujos de trabajo de desarrollo e implementación. La CLI se integra sin esfuerzo con las potentes funciones en la nube de Apidog y está optimizada para ejecutar escenarios de prueba en cualquier entorno, lo que garantiza una retroalimentación rápida sobre la integridad de la API en múltiples etapas de su canalización.
Configuración de Apidog CLI
Para comenzar a usar Apidog CLI, asegúrese de que su entorno esté equipado con Node.js versión 16 o superior. Apidog CLI se puede instalar fácilmente a través de npm, lo que le permite ponerse en marcha con solo unos pocos comandos:
npm install -g apidog-cli
Una vez instalado, verificar su configuración es simple. El siguiente comando verifica su versión de Node.js, la versión de la CLI y las rutas de instalación de Node, npm y Apidog:
node -v && apidog -v && which node && which npm && which apidog
Esto garantiza que su sistema esté configurado correctamente para usar Apidog CLI y ayuda a solucionar cualquier problema de configuración.
Ejecución de escenarios de prueba en Apidog CLI
Apidog CLI está diseñado para ejecutar escenarios de prueba de manera eficiente, brindándole flexibilidad en la forma en que autentica y ejecuta las pruebas. Puede especificar un escenario de prueba ya sea por su ID único o haciendo referencia a una carpeta que contenga una colección de escenarios de prueba. Esta característica simplifica la ejecución de pruebas de API a gran escala en múltiples entornos y configuraciones.
Aquí hay un ejemplo de cómo ejecutar un escenario de prueba usando un token de acceso de Apidog:
apidog run --access-token <your-access-token> -t <test-scenario-id>
Este comando ejecuta el escenario de prueba basado en su ID, mientras pasa de forma segura las credenciales de autenticación a través del token de acceso. Si necesita ejecutar todos los escenarios de prueba en una carpeta en particular, simplemente puede usar el ID de la carpeta en su lugar:
apidog run --access-token <your-access-token> -f <test-scenario-folder-id>
Opciones avanzadas de CLI para una personalización detallada
Una de las fortalezas de Apidog CLI radica en sus opciones avanzadas de línea de comandos. Puede configurar informes de prueba, variables de entorno, certificados SSL e incluso introducir retrasos o tiempos de espera entre solicitudes. Apidog permite un control preciso sobre su proceso de prueba, ya sea que esté ejecutando un solo escenario de prueba o ejecutando un lote de pruebas de forma iterativa en diferentes entornos.
Aquí hay un ejemplo de cómo generar un informe personalizado en formatos JSON y JUnit, y guardarlo en un directorio específico:
apidog run <collection> --reporters json,junit --out-dir ./test-reports
Con Apidog CLI, también puede definir variables de entorno dinámicamente, asegurando que sus escenarios de prueba sean sensibles al contexto y puedan adaptarse a los cambios en las configuraciones de la API sin modificar los scripts centrales:
apidog run <collection> --env-var "BASE_URL=https://staging.api.com" --env-var "TOKEN=abc123"
Este tipo de flexibilidad asegura que Apidog se ajuste perfectamente a su infraestructura de prueba existente.
Certificados SSL y pruebas de seguridad
En el mundo actual, la validación SSL es crucial al probar las API. Apidog CLI admite el paso de certificados de cliente, lo que permite conexiones seguras a sus API durante las pruebas. Ya sea que esté utilizando un solo certificado o varios certificados basados en dominios específicos, Apidog simplifica el proceso. Puede especificar un solo certificado de cliente para sus pruebas:
apidog run <collection> --ssl-client-cert ./path/to/cert.pem --ssl-client-key ./path/to/key.pem
O, para configuraciones más complejas, puede usar un archivo JSON que contenga una lista de certificados de cliente que coincidan con URL específicas:
apidog run <collection> --ssl-client-cert-list ./path/to/ssl-cert-list.json
¿Por qué cambiar a Apidog?
Apidog CLI ofrece una experiencia mejorada para los equipos que buscan un rendimiento más rápido, una integración más fácil y más control sobre sus flujos de trabajo de prueba de API. Proporciona la flexibilidad de las potentes herramientas de línea de comandos al tiempo que se integra con la plataforma rica en funciones de Apidog, lo que la convierte en una sólida alternativa a la CLI de Postman.
Si ya está familiarizado con Postman, la transición a Apidog CLI se sentirá intuitiva, pero notará de inmediato la flexibilidad y la potencia adicionales que ofrece Apidog. Su rico conjunto de características, combinado con informes extensos y administración dinámica del entorno, convierte a Apidog en un fuerte contendiente para los desarrolladores que necesitan una solución de prueba de API eficiente y escalable.
Conclusión
En conclusión, si bien Postman ha sido durante mucho tiempo un elemento básico en el espacio de las pruebas de API, la CLI de Apidog ofrece una alternativa robusta adaptada para flujos de trabajo modernos y automatizados. Con sus opciones de comando avanzadas, la administración fluida del entorno y las capacidades de informes flexibles, Apidog CLI permite a los equipos probar y validar de manera eficiente las API en varias etapas de desarrollo e implementación. Si está buscando una herramienta potente y flexible que se integre fácilmente en sus canalizaciones CI/CD, vale la pena explorar Apidog CLI. Ofrece un enfoque optimizado para las pruebas de API, lo que garantiza que sus API sigan siendo confiables, seguras y de alto rendimiento.
