GUI-GDT-007 Pruebas con Postman

v 1.0

Objetivo

Proporcionar orientación sobre cómo realizar pruebas a los endpoints de la API utilizando Postman, asegurando la funcionalidad y la correcta comunicación entre el frontend y el backend.

Notas introductorias

Postman es una herramienta de colaboración para el desarrollo de APIs que facilita el diseño, la simulación y la prueba de APIs de manera eficiente y colaborativa. Esta guía se centra en su uso para realizar pruebas manuales.

Application Programming Interface (API)

Una API (Interfaz de Programación de Aplicaciones) es un conjunto de reglas y protocolos que permite a diferentes aplicaciones de software comunicarse entre sí. Define los métodos y formatos de datos que las aplicaciones pueden utilizar para solicitar e intercambiar información. Las API se utilizan comúnmente en el desarrollo web para permitir interacciones entre servidores web y clientes, o entre diferentes servicios dentro de una aplicación web.

Contenido

1. Configuración de Postman

• Descargar e instalar Postman desde Postman.
• Crear una cuenta en Postman para sincronizar colecciones y entornos de prueba.

2. Crear una colección

• Una colección en Postman es un conjunto de peticiones agrupadas.
• Para crear una colección, haz clic en el botón "New" y selecciona "Collection".
• Asigna un nombre a la colección y guarda los cambios.

3. Añadir una petición

• Dentro de la colección creada, haz clic en "Add Request".
• Define el nombre de la petición y selecciona el método HTTP adecuado (GET, POST, PUT, DELETE).
• Especifica la URL del endpoint que quieres probar.

4. Configurar parámetros y headers

• Si la petición requiere parámetros (query, path, body), añádelos en la sección correspondiente.
  • Query Parameters: Son los parámetros que se añaden a la URL después del signo de interrogación (?).
  • Path Parameters: Son los parámetros que forman parte de la ruta de la URL.
  • Body Parameters: Son los parámetros que se envían en el cuerpo de la solicitud, generalmente en métodos POST y PUT.
• Añade headers necesarios, como el Content-Type para especificar el tipo de contenido (por ejemplo, application/json) o Authorization para el token de autenticación.

5. Ejecutar la petición

• Haz clic en el botón "Send" para ejecutar la petición.
• Observa la respuesta en la sección inferior, donde se mostrará el código de estado (por ejemplo, 200 para éxito, 404 para no encontrado, 500 para error del servidor), los headers de la respuesta y el cuerpo de la respuesta.
• Verifica que la respuesta coincida con las expectativas. Revisa el cuerpo de la respuesta para asegurarte de que los datos sean correctos y que los headers contengan la información esperada.

6. Guardar las peticiones y respuestas

• Guarda las peticiones y sus respuestas para referencia futura.
• Puedes hacer esto manualmente seleccionando la opción de guardar en Postman, o automáticamente si tienes una cuenta sincronizada.

7. Uso de variables y entornos

• Las variables en Postman permiten reutilizar valores de manera eficiente. Puedes definir variables globales, de colección o de entorno.
• Configura entornos para pruebas de desarrollo, pruebas y producción, utilizando variables de entorno. Esto facilita cambiar entre diferentes configuraciones sin modificar las peticiones individuales.
  • Para crear un entorno, ve a la sección "Environments" y haz clic en "Add". Define el nombre del entorno y las variables que necesitas.
  • Usa las variables en las peticiones utilizando la sintaxis {{variable_name}}.

8. Documentar y compartir

• Utiliza las herramientas de documentación de Postman para generar documentación de la API.
• Comparte las colecciones con tu equipo para colaboración. Puedes hacerlo exportando la colección como un archivo JSON o compartiéndola directamente desde Postman si tienes una cuenta sincronizada.

Control de cambios

Versión	Cambio realizado	Análisis	Autor	Revisor(es)	Fecha de cambio
v 1.0	Creación de la guía	N/A	Carlos Salguero	Sergio Garnica	16/05/2024