¿Cómo usar scripts post-solicitud en Postman?

Probablemente estés familiarizado con Postman. Si eres un desarrollador o probador de API, probablemente ya estés familiarizado con Postman. Es una herramienta popular para probar API y está repleta de funciones que facilitan la simulación de solicitudes y el análisis de respuestas. Pero, ¿sabías que también puedes usar Postman para automatizar tareas y agregar comportamiento dinámico a tus solicitudes? Ahí es donde entran los scripts post-request.

¿Qué son los scripts Post-Request?

Los scripts post-request, también conocidos como scripts de prueba, son fragmentos de código JavaScript que Postman ejecuta después de enviar una solicitud. Estos scripts se ejecutan después de que se envía la solicitud real y se recibe la respuesta. Se utilizan para verificar si la API está funcionando correctamente, validar integraciones y garantizar que los nuevos desarrollos no hayan afectado la funcionalidad existente.

Mientras que los scripts pre-request configuran la solicitud, los scripts post-request analizan la respuesta. Por ejemplo, puedes verificar que los datos esperados estén presentes en la respuesta o realizar comprobaciones adicionales.

¿Qué es postman?

Postman es una plataforma de desarrollo y prueba de API que ofrece una variedad de funciones. Permite a los desarrolladores crear y compartir fácilmente solicitudes y colecciones de API, automatizar pruebas, simular API y supervisar el rendimiento. Postman también proporciona herramientas de colaboración y documentación, lo que permite a los equipos trabajar juntos de manera más eficiente y comunicar el comportamiento de la API de manera efectiva.

¿Cuándo usar scripts Post-Request?

Los scripts post-request son increíblemente versátiles y puedes usarlos en muchos escenarios diferentes. Los scripts post-request se ejecutan después de que se recibe la respuesta. Se utilizan para verificar si la API está funcionando correctamente, comprobar las integraciones y garantizar que los nuevos cambios no hayan afectado la funcionalidad existente. Puedes escribir scripts de prueba en JavaScript para validar la respuesta.

¿Cómo usar los scripts Post-Request?

1. Abre Postman y Navega a la pestaña "Tests" que está al lado de las pestañas "Headers" y "Body" en la ventana de solicitud.

Escribe tus pruebas de JavaScript en esta pestaña. Postman proporciona un rico conjunto de fragmentos en el lado derecho para ayudarte a comenzar. Por ejemplo, la longitud de los elementos de datos debe ser mayor que cero:

Escribe tus pruebas de JavaScript en esta pestaña. Postman proporciona un rico conjunto de fragmentos en el lado derecho para ayudarte a comenzar. Por ejemplo, para verificar si el cuerpo de la respuesta contiene una determinada cadena, puedes usar:

// Verify the length of data elements
pm.test("The length of data elements should be greater than zero", function () {
    const responseData = pm.response.json();
    
    pm.expect(responseData.data.id.length).to.be.greaterThan(0, "ID should not be empty");
    pm.expect(responseData.data.name.length).to.be.greaterThan(0, "Name should not be empty");
    pm.expect(responseData.data.photoUrls.length).to.be.greaterThan(0, "PhotoUrls should not be empty");
    pm.expect(responseData.data.category.id).to.be.greaterThan(0, "Category ID should not be empty");
    pm.expect(responseData.data.category.name.length).to.be.greaterThan(0, "Category name should not be empty");
    responseData.data.tags.forEach((tag)=>{
        pm.expect(tag.id).to.be.greaterThan(0, "Tag ID should not be empty");
        pm.expect(tag.name.length).to.be.greaterThan(0, "Tag name should not be empty");
    });
    pm.expect(responseData.data.status.length).to.be.greaterThan(0, "Status should not be empty");
});

En la pestaña "Test Results" en la parte inferior de la sección de respuesta. Si tu script ha pasado, aparecerá en verde; si ha fallado, estará en rojo.

Usar Post-Request en scripts de Apidog.

Apidog es un conjunto completo de herramientas que conecta todo el ciclo de vida de la API. Combina funciones de herramientas como Postman, Swagger, Mock y JMeter. Apidog ayuda a los equipos de I+D a implementar las mejores prácticas para el desarrollo API Design-first. Su interfaz fácil de usar facilita el diseño, la depuración, la documentación, la simulación y la prueba de API.

Usar scripts post-request en Apidog es una excelente manera de automatizar las pruebas de tus respuestas de API. Aquí tienes una guía paso a paso sobre cómo usarlos:

Configura tu solicitud:

• En Apidog, crea una nueva solicitud haciendo clic en el botón "+" o seleccionando "New API".
• Ingresa la URL del recurso que deseas actualizar (el endpoint donde enviarás tu solicitud POST).
• Agrega cualquier encabezado o parámetro adicional que necesites para tu solicitud.

Escribe scripts Post-Request:

• Navega a la pestaña "Post processors" al lado de las pestañas "Headers" y "Body" en la ventana de solicitud.

// Verify the length of data elements
pm.test("The length of data elements should be greater than zero", function () {
    const responseData = pm.response.json();
    
    pm.expect(responseData.data.id.length).to.be.greaterThan(0, "ID should not be empty");
    pm.expect(responseData.data.name.length).to.be.greaterThan(0, "Name should not be empty");
    pm.expect(responseData.data.photoUrls.length).to.be.greaterThan(0, "PhotoUrls should not be empty");
    pm.expect(responseData.data.category.id).to.be.greaterThan(0, "Category ID should not be empty");
    pm.expect(responseData.data.category.name.length).to.be.greaterThan(0, "Category name should not be empty");
    responseData.data.tags.forEach((tag)=>{
        pm.expect(tag.id).to.be.greaterThan(0, "Tag ID should not be empty");
        pm.expect(tag.name.length).to.be.greaterThan(0, "Tag name should not be empty");
    });
    pm.expect(responseData.data.status.length).to.be.greaterThan(0, "Status should not be empty");
});

Apidog te permite agregar diferentes tipos de script post-request

Envía la solicitud POST:

• Haz clic en el botón "Send" para ejecutar tu solicitud POST.

Visualiza los resultados de la prueba en la pestaña a la derecha de la sección de respuesta. Si tu script ha pasado, aparecerá en verde; si ha fallado, estará en rojo.

Los scripts post-request son particularmente útiles para:

• Validar la respuesta: Asegurarse de que la API devuelva el código de estado, el tiempo de respuesta y la estructura de datos esperados.
• Establecer variables de entorno: Extraer datos de la respuesta y establecerlos como una variable de entorno para su uso en solicitudes posteriores.
• Pruebas basadas en datos: Comparar la respuesta con un conjunto de datos para la validación.

Conclusión

Los scripts post-request son una característica poderosa de Postman que puede ayudarte a automatizar tareas, agregar comportamiento dinámico a tus solicitudes y garantizar que tus API funcionen como se espera. Entonces, ¿por qué no darles una oportunidad? Podrías sorprenderte de lo mucho que pueden simplificar tu proceso de prueba de API.