Ejemplos de scripts de prueba de Postman que necesitas conocer

En el ámbito del desarrollo de API, las pruebas exhaustivas son cruciales para garantizar la funcionalidad y la fiabilidad. Postman, un cliente de API popular, ofrece sólidas capacidades de prueba a través de su función de scripting.

Este artículo profundiza en ejemplos prácticos de scripts de prueba de Postman, proporcionando a los desarrolladores una comprensión clara de cómo aprovechar esta funcionalidad para una validación de API eficaz.

Roles de los scripts de prueba de Postman

Validación de respuestas de API

• Códigos de estado: Los scripts de prueba verifican si la API responde con el código de estado esperado. Por ejemplo, asegurarse de que una solicitud exitosa devuelva un 200 OK o manejar códigos de error como 404 No encontrado.
• Cuerpo de la respuesta: Los scripts pueden profundizar en el cuerpo de la respuesta para asegurarse de que contiene los datos deseados. Esto podría implicar la comprobación de la presencia de campos específicos en las respuestas JSON, la validación del formato de los datos (por ejemplo, números, cadenas) o la verificación de la estructura del objeto de respuesta.
• Integridad de los datos: Los scripts pueden confirmar la precisión de los datos de respuesta comparándolos con los valores esperados. Esto puede implicar la comparación con valores codificados, variables de entorno o cálculos basados en parámetros de solicitud.

Manejo de errores y casos extremos

• Respuestas de error: Los scripts pueden manejar escenarios de error comprobando códigos de error específicos en la respuesta y verificando si el mensaje de error se alinea con las expectativas.
• Casos extremos: Las pruebas se pueden diseñar para simular condiciones inusuales y garantizar que la API se comporte como se espera; por ejemplo, probar el comportamiento con solicitudes vacías, tipos de datos no válidos o superar los límites definidos.

Automatización de tareas repetitivas

• Optimización de los flujos de trabajo: Los scripts pueden automatizar tareas de prueba repetitivas, ahorrando a los desarrolladores tiempo y esfuerzo valiosos. Estos podrían incluir el envío de múltiples solicitudes con diferentes parámetros o la comprobación repetida de puntos de datos específicos en las respuestas.
• Aumento de la coherencia: Los scripts garantizan procedimientos de prueba coherentes durante todo el desarrollo, lo que reduce el riesgo de error humano y garantiza una cobertura completa.

Mejora de la mantenibilidad y la colaboración

• Scripts reutilizables: Una vez escritos, los scripts se pueden reutilizar en diferentes solicitudes y colecciones de API, lo que promueve la reutilización del código y reduce los gastos generales de mantenimiento.
• Colaboración mejorada: Los scripts se pueden compartir y documentar dentro de los espacios de trabajo de Postman, lo que permite a los equipos colaborar en los esfuerzos de prueba de API.

Simplificación de validaciones complejas

• Aprovechamiento de las aserciones: El scripting de Postman utiliza bibliotecas como Chai para realizar aserciones potentes. Estas permiten comparaciones de datos complejas, comprobaciones lógicas y manipulaciones de cadenas dentro de los scripts.
• Lógica personalizada: Los scripts se pueden adaptar para implementar reglas de validación o cálculos específicos basados en la funcionalidad de la API. Esto añade una capa de flexibilidad y control al proceso de prueba.

Beneficios de usar scripts de prueba de Postman

Mayor eficiencia y automatización

• Reducción de las pruebas manuales: Los scripts automatizan las tareas de prueba repetitivas, lo que permite a los desarrolladores centrarse en aspectos más complejos del desarrollo de API. Esto se traduce en ciclos de desarrollo más rápidos y una mejor asignación de recursos.
• Cobertura de pruebas mejorada: Los scripts se pueden diseñar para probar una gama más amplia de escenarios en comparación con las pruebas manuales, lo que lleva a una validación de API más completa.
• Reducción de la inversión de tiempo: La automatización de las pruebas ahorra a los desarrolladores una cantidad significativa de tiempo que antes dedicaban a la ejecución y verificación manual.

Mayor fiabilidad y mantenibilidad de la API

• Detección temprana de problemas: Los scripts detectan errores e inconsistencias en el comportamiento de la API al principio del ciclo de vida del desarrollo, lo que permite realizar correcciones rápidas y evitar que los problemas lleguen a producción.
• Pruebas coherentes: Los scripts garantizan procedimientos de prueba coherentes en todas las etapas de desarrollo, lo que reduce el riesgo de regresiones y garantiza que la API funcione como se espera a lo largo de su ciclo de vida.
• Calidad del código mejorada: Las pruebas automatizadas promueven un enfoque en la escritura de código de API limpio y bien estructurado, lo que lleva a una base de código más fiable y mantenible.

Mayor confianza del desarrollador

• Comportamiento fiable de la API: La validación automatizada garantiza que la API se comporte de forma coherente y se ajuste a las expectativas, lo que aumenta la confianza del desarrollador en su funcionalidad.
• Reducción de riesgos y errores: Las pruebas proactivas con scripts minimizan la posibilidad de que errores y comportamientos inesperados se filtren en la producción, lo que reduce el estrés y mejora la experiencia general de desarrollo.
• Visibilidad mejorada de la cobertura de pruebas: Los scripts proporcionan una imagen clara de qué aspectos de la API se han probado, lo que da a los desarrolladores una sensación de progreso y confianza en la calidad general de la API.

Colaboración y documentación optimizadas

• Scripts reutilizables: Los scripts compartidos y bien documentados dentro de los espacios de trabajo de Postman permiten una colaboración eficiente entre los equipos de desarrollo, lo que promueve el intercambio de conocimientos y reduce la duplicación de esfuerzos.
• Comunicación mejorada: Los scripts actúan como una herramienta de comunicación clara, documentando los casos de prueba de la API y el comportamiento esperado para que todos los miembros del equipo puedan consultarlos.
• Prácticas de prueba coherentes: Los scripts compartidos por el equipo garantizan que todos utilicen los mismos procedimientos de prueba, lo que fomenta un enfoque unificado para la validación de la API.

Ejemplos de scripts de prueba de Postman

Aquí hay cuatro ejemplos de código que muestran scripts de prueba de Postman con una complejidad creciente.

Ejemplo 1: verificación del código de estado

pm.test("Solicitud GET exitosa", () => {
  pm.response.to.have.status(200);
});

Explicación del código:

Este script comprueba si la API responde con un código de estado 200 (OK), lo que indica una solicitud GET exitosa.

Ejemplo 2: validación de la estructura de la respuesta JSON

pm.test("La respuesta tiene las propiedades esperadas", () => {
  pm.expect(pm.response.json()).to.have.property("name");
  pm.expect(pm.response.json()).to.have.property("id").to.be.a("number");
});

Explicación del código:

Este script garantiza que la respuesta JSON contenga propiedades específicas ( name e id ) y verifica que la propiedad id sea un número.

Ejemplo 3: uso de variables de entorno

const baseUrl = pm.environment.get("apiUrl");
const expectedUserId = pm.environment.get("userId");

pm.test("GET Usuario por ID", () => {
  pm.expect(pm.response.json().id).to.equal(expectedUserId);
});

pm.sendRequest(baseUrl + "/users/" + expectedUserId);

Explicación del código:

Este ejemplo utiliza variables de entorno para la URL base y el ID de usuario esperado. A continuación, el script valida si el id de los datos de respuesta coincide con el ID de usuario esperado almacenado en el entorno.

Ejemplo 4: manejo de errores con aserciones de Chai

pm.test("Manejo de errores para un usuario inexistente", () => {
  pm.expect(pm.response.code).to.equal(404);
  pm.expect(pm.response.json().error).to.equal("Usuario no encontrado");

  // Uso de aserciones de Chai para validaciones complejas
  pm.expect(pm.response.json().message).to.contain("El ID de usuario solicitado no existe");
});

pm.sendRequest("http://localhost:3000/users/12345"); // Suponiendo un ID de usuario inexistente

Explicación del código:

Este script comprueba si hay un código de error 404 y valida la presencia de mensajes de error específicos en la respuesta. Además, aprovecha las aserciones de Chai para verificar si el mensaje de error contiene una cadena específica, lo que demuestra capacidades de validación más complejas.

Crea APIs cómodamente con Apidog

Si estás buscando una alternativa a Postman, asegúrate de considerar probar Apidog, una herramienta integral de desarrollo de API que proporciona funcionalidades más lujosas.

Importa APIs a Apidog para su modificación

Da tu primer paso para perfeccionar tu API importándola a Apidog. Apidog admite varios tipos de archivos de API, incluidos OpenAPI (o Swagger), Postman e Insomnia.

Primero, abre la sección Configuración en tu proyecto y localiza el botón Importar datos que se encuentra en Administración de datos. Si no encuentras el tipo de archivo que deseas importar, ¡no te preocupes! Simplemente arrastra y suelta el archivo en la parte inferior de la pantalla.

Añadir scripts de prueba en Apidog

Una vez que hayas terminado de importar tu API o crear un nuevo proyecto en Apidog, puedes proceder a añadir scripts de prueba.

En la sección Editar de tu API, localiza el encabezado Preprocesadores. Deberías encontrar una barra que está etiquetada como Script personalizado. Aquí es donde puedes implementar scripts personalizados para tus solicitudes de API. Si tienes problemas para averiguar qué escribir, también puedes seleccionar las opciones de Fragmento de código que se encuentran a la derecha del espacio de código.

Conclusión

Los scripts de prueba de Postman permiten a los desarrolladores mejorar sus prácticas de prueba de API. Al automatizar las tareas repetitivas y permitir validaciones exhaustivas, los scripts agilizan el proceso de desarrollo y mejoran la calidad y la fiabilidad generales de las API.

Desde las comprobaciones básicas del código de estado hasta las verificaciones de datos complejas con el manejo de errores, las capacidades de scripting dentro de Postman proporcionan una solución potente y flexible para las pruebas de API. Te animamos a explorar el vasto potencial de los scripts de prueba de Postman y a aprovecharlos para garantizar que tus API funcionen a la perfección y ofrezcan experiencias excepcionales.