Tutorial POSTMAN: Pruebas de API con POSTMAN

postman tutorial api testing using postman

Este tutorial paso a paso explica las pruebas de API con POSTMAN, incluidos los conceptos básicos de POSTMAN, sus componentes y solicitud y respuesta de muestra:

Echamos un vistazo a las preguntas más frecuentes. Preguntas de la entrevista de ASP.Net y Web API en nuestro tutorial anterior. Al seguir este tutorial, aprenderá cómo abordamos las pruebas de API a través de POSTMAN para cualquier URL determinada.

Postman es una aplicación o herramienta de prueba de API muy simple e intuitiva. Cada componente de POSTMAN es muy importante ya que tiene su propio significado.

=> Lea la serie completa de pruebas de API aquí .

el mejor software de máquina virtual para windows

Lista de todos los tutoriales del cartero en esta serie

Tutorial #1: Introducción al cartero (este tutorial)
Tutorial #2: Cómo utilizar Postman para probar formatos de API Diff
Tutorial #3: Cartero: ámbitos variables y archivos de entorno
Tutorial #4: Colecciones de cartero: importar, exportar y generar muestras de código
Tutorial #5: Automatización de validaciones de respuesta con afirmaciones
Tutorial #6: Cartero: Scripts de solicitud previa y posterior
Tutorial #7: Postman Advanced Scripting
Tutorial #8: Postman: integración de la línea de comandos con Newman
Tutorial #9: Cartero: plantillas de informes con Newman
Tutorial #10: Postman: creación de documentación API
Tutorial #11: Preguntas de la entrevista del cartero

Descripción general de los tutoriales en la serie Postman

Lo que vas a aprender:

• CARTERO Introducción
• Instalación del CARTERO
  • Aplicación nativa de cartero
  • Guía de instalación alternativa rápida del cartero
  • Bloques de construcción de cartero
    • # 1) Solicitud
    • # 2) Colección
    • # 3) Medio ambiente
  • Guardar una solicitud en una colección
• Ejemplo de solicitud y respuesta
• Actualización: información adicional
  • ¿Qué es una API?
  • Cliente POSTMAN
    • ¿Cómo descargar el cliente POSTMAN?
  • Llamar a las API REST mediante el cliente POSTMAN
    • # 1) OBTENER LLAMADA
    • # 2) POST LLAMADA
    • # 3) PUT Call
    • # 4) Eliminar llamada
  • Desafíos en las pruebas de API
• Conclusión
  • Lectura recomendada

CARTERO Introducción

POSTMAN es un cliente de API que se utiliza para desarrollar, probar, compartir y documentar API. Se utiliza para pruebas de back-end donde ingresamos la URL del punto final, envía la solicitud al servidor y recibe la respuesta del servidor. Lo mismo se puede lograr a través de plantillas API como Swagger. Tanto en Swagger como en POSTMAN, no tenemos que crear un marco (a diferencia de Parasoft) para obtener la respuesta del servicio.

Esta es la razón principal por la que los desarrolladores e ingenieros de automatización utilizan POSTMAN con frecuencia para garantizar que el servicio esté en funcionamiento junto con la versión de compilación de una API que se está implementando en la región.

Básicamente, ayuda a llegar a los puntos finales de la API al crear rápidamente solicitudes según la especificación de la API y analizar los diversos parámetros de respuesta, como el código de estado, los encabezados y el cuerpo de respuesta real en sí.

Aquí hay un tutorial en video:

Postman ofrece muchas funciones avanzadas como:

• Desarrollo de API.
• Configuración de puntos finales simulados para API que aún están en desarrollo.
• Documentación de API.
• Afirmaciones de las respuestas recibidas de la ejecución del punto final de la API.
• Integración con herramientas CI-CD como Jenkins, TeamCity, etc.
• Automatización de la ejecución de pruebas de API, etc.

Ahora, hemos pasado por la introducción formal de la herramienta, pasemos a la parte de instalación.

Instalación del CARTERO

Cartero está disponible en 2 opciones.

1. Como una aplicación de Chrome (esto ya está obsoleto y no tiene el apoyo de los desarrolladores de Postman)
2. Aplicación nativa para diferentes plataformas como Windows, Mac OS, Linux, etc.

Como las aplicaciones de Chrome están en desuso y tienen un acoplamiento estrecho con el navegador Chrome (en algunos casos, la versión real del navegador), nos centraremos principalmente en el uso de la aplicación nativa que nos da más control y tiene menos dependencias externas.

Aplicación nativa de cartero

La aplicación Postman Native es una aplicación independiente que está disponible para descargar en varias plataformas de sistemas operativos como Windows, Mac OS, Linux, etc. Se puede descargar como cualquier otra aplicación dependiendo de la plataforma del usuario.

El proceso de instalación también es bastante sencillo. Simplemente debe hacer doble clic en el instalador descargado (para Windows y Mac) y seguir las instrucciones.

Una vez que la instalación sea exitosa, simplemente abra la aplicación Postman para comenzar.

Veremos cómo crear una solicitud simple para cualquier API de código abierto disponible y veremos los diversos componentes de la solicitud y la respuesta recibidas cuando la solicitud se ejecuta utilizando la aplicación Postman.

Es muy recomendable iniciar sesión / registrarse en la aplicación Postman con una cuenta de correo electrónico existente. Una cuenta iniciada conserva todas las colecciones y solicitudes de Postman que se guardan durante la sesión y garantiza que las solicitudes aún estén disponibles para trabajar cuando el mismo usuario inicie sesión la próxima vez.

por favor refiérase a Nota sección para obtener detalles sobre el punto final de API falso disponible públicamente.

Ilustraremos una solicitud GET de muestra a este URL que devolvería 100 publicaciones en respuesta como JSON Payload.

Comencemos y veamos los pasos que deben seguirse:

#1) Abra la aplicación Postman (si aún no ha iniciado sesión con la cuenta nueva o existente, primero inicie sesión con las credenciales adecuadas).

A continuación se muestra la imagen de la pantalla inicial de la interfaz de usuario de Postman:

#2) Cree una nueva solicitud y complete los detalles según el punto final que usaremos para nuestra prueba o ilustración. Probemos una solicitud de obtención para un extremo de la API REST http://dummy.restapiexample.com/api/v1/employees

#3) Una vez que se hayan completado las propiedades de la solicitud, presione ENVIAR para ejecutar la solicitud al servidor que aloja el punto final.

#4) Una vez que el servidor responde, podemos verificar los diversos datos alrededor de la respuesta.

Veamos cada uno de ellos en detalle.

De forma predeterminada, una vez que se completa la respuesta, se selecciona y se muestra la pestaña del cuerpo de la respuesta. Otros parámetros para una respuesta, como el código de estado de la respuesta, el tiempo que tarda la solicitud en completarse y el tamaño de la carga útil, se muestran justo debajo de los encabezados de la solicitud (como en la siguiente figura).

Para obtener detalles detallados sobre los parámetros de respuesta, como el tamaño de respuesta y el tiempo de respuesta, simplemente puede colocar el cursor sobre cada uno de esos valores, y Postman le mostrará una vista detallada con detalles más detallados para cada una de esas propiedades.

Por ejemplo, para el tiempo de solicitud: lo dividirá en componentes individuales como tiempo de conexión, tiempo de socket, búsqueda de DNS, protocolo de enlace, etc.

De manera similar, para el tamaño de la respuesta, le mostrará un desglose de cuánto tamaño están constituidos los encabezados y cuál es el tamaño real de la respuesta.

Ahora, veamos las otras pestañas de respuesta, es decir, cookies y encabezados. En el mundo web, las cookies tienen mucha importancia en términos de impulsar las experiencias del lado del cliente y mucha información relacionada con la sesión para obtener toda la información sobre las cookies que fueron devueltas desde el servidor. Puede cambiar a la pestaña de cookies y ver esto.

Del mismo modo, los encabezados de respuesta contienen mucha información beneficiosa sobre la solicitud que se procesó. Simplemente navegue a la pestaña de encabezados en la sección de respuesta para ver los encabezados de respuesta.

Un punto importante a tener en cuenta aquí es que todas las solicitudes que realiza al servidor se almacenan en el historial de Postman para referencia futura (la pestaña Historial está disponible en el panel lateral izquierdo de la aplicación).

Esto ayuda a prevenir la creación de solicitudes cada vez que necesita obtener una respuesta para la misma solicitud y también ayuda a evitar tareas repetitivas mundanas. Si es necesario, puede consultar las solicitudes pasadas (y también las respuestas) en un momento futuro.

Nota: Para ilustrar solicitudes y respuestas de muestra, utilizaremos servidores API falsos disponibles públicamente que permitirán que se realicen todos los tipos de solicitudes HTTP y que devuelvan una respuesta HTTP válida.

Para nombrar algunos, usaremos los siguientes sitios de puntos finales de API falsos como referencia:

1. Ejemplo de API de descanso
2. Tipo de marcador de posición JSON

Guía de instalación alternativa rápida del cartero

POSTMAN es una herramienta abierta y está disponible para cualquier persona que navegue por Internet. Puede seguir los pasos a continuación y obtener la herramienta POSTMAN instalada en su máquina local.

Paso 1: Abierto Google y busque la herramienta POSTMAN. Obtendrá el siguiente resultado de búsqueda. Luego, puede hacer clic en Descargar la aplicación Postman y será redirigido al sitio web de getpostman.

De lo contrario, puede navegar directamente a este URL para obtener la herramienta POSTMAN.

Paso 2: Seleccione la versión POSTMAN según su sistema operativo. En nuestro caso, vamos a utilizar POSTMAN para el sistema operativo Windows. Además, estamos usando Window-64 bit, por lo que descargaremos e instalaremos POSTMAN para 64 bit.

Paso 3: Una vez que haya hecho clic en el botón Descargar, se descargará un archivo postman.exe en su archivo local. Haga clic en ese archivo. Es una instalación con un solo clic como cualquier otra aplicación que le permitirá instalar el complemento POSTMAN para su navegador.

Paso 4: Una vez que haya instalado la aplicación, haga clic en la aplicación (que debe colocarse en su escritorio). Como puede ver en la imagen a continuación, tenemos seis entidades diferentes para las cuales básicamente necesitará tres bloques de construcción, es decir, Solicitud, Colección y Entorno que se discutirán en la siguiente sección.

¡¡Eso es!! Hemos instalado y lanzado con éxito la aplicación POSTMAN.

Bloques de construcción de cartero

POSTMAN tiene una variedad de bloques de construcción, pero para nuestro propósito, vamos a discutir los tres bloques de construcción principales que son esenciales para cada operación de POSTMAN.

Estos tres bloques de construcción principales son:

# 1) Solicitud

Una solicitud no es más que una combinación de la URL completa (que incluye todos los parámetros o claves), encabezados HTTP, cuerpo o carga útil. Todos estos atributos forman una solicitud. POSTMAN te permite guardar tu solicitud y esta es una buena característica de la aplicación que nos permite usar la misma solicitud tantas veces como queramos.

Haga clic en Nuevo -> Solicitud

# 2) Colección

Debe haber algo donde guardará sus solicitudes masivas. Este es el escenario en el que la colección entra en escena. Podemos decir que una colección es un repositorio en el que podemos guardar todas nuestras solicitudes. Generalmente, las solicitudes que llegan a la misma API se mantienen en la misma colección.

Haga clic en Nuevo -> Colección.

# 3) Medio ambiente

Un entorno es una región donde se llevarán a cabo todas sus operaciones en una API. Podría ser TUP, QA, Dev, UAT o PROD. Cada proyecto ya tendrá las regiones configuradas y solo tienes que declarar tus variables globales como URL, ID y contraseña del token, claves de contexto, claves de API, claves de documento, etc.

Haga clic en Nuevo -> Medio ambiente.

Guardar una solicitud en una colección

Ahora intentaremos guardar una solicitud de muestra en una colección y usaremos la misma solicitud para acceder a una API.

Paso 1: En la esquina superior derecha, verá el botón '+ Nuevo'. Haga clic en este botón y tendrá la lista de los componentes básicos que se mostraron cuando inició la aplicación por primera vez.

Paso 2: Haga clic en Solicitar.

Paso 3: Proporcione el nombre de la solicitud, que es un campo obligatorio. Luego haga clic en '+ Crear colección'.

Paso 4: Una vez que haya hecho clic en “+ Crear colección”, le pedirá un nombre (por ejemplo, Colección de muestra). Ingrese el nombre de la colección y presione enter.

Paso 5: Clickea en el 'Guardar en la colección de muestras' botón.

Ejemplo de solicitud y respuesta

Esta sección en particular le dará una visión profunda de cómo probar una API en POSTMAN.

Como puede ver en la imagen de abajo, tenemos nuestra Solicitud que ya hemos creado (Prueba para SoftwareTestingHelp). Además, puede ver un menú desplegable (justo al lado de la URL) que contiene los verbos o métodos admitidos por el POSTMAN.

Estos se denominan verbos HTTP. Intentaremos actualizar algo usando el método PUT y luego lo recuperaremos usando el método GET. Supongo que los lectores conocen la funcionalidad de estos verbos HTTP que se utilizan en las pruebas de API.

Ahora, tenemos una URL y un método de solicitud. Todo lo que necesitamos son los encabezados y la carga útil o el cuerpo. En algunos casos, necesitamos generar tokens (según las necesidades de una API).

Declararemos nuestros encabezados HTTP, es decir, Content-Type y Accept. Aceptar no siempre es obligatorio, ya que decide el formato en el que recuperaremos nuestra respuesta. De forma predeterminada, la respuesta es siempre JSON.

No es necesario asaltar los valores de estos encabezados ya que POSTMAN le proporcionará las sugerencias cuando escriba en las áreas de texto de la clave y el valor.

Luego, pasaremos a la siguiente sección obligatoria que es Cuerpo. Aquí proporcionaremos la carga útil en forma de JSON. Somos conscientes de cómo escribir nuestro propio JSON, por lo que intentaremos crear nuestro propio JSON.

Solicitud de muestra

URL: http://www.mocky.io/v2/5cd6c3f23000004b006061c5

Encabezados

Tipo de contenido: aplicación / JSON
Aceptar = aplicación / JSON

Cuerpo

Ahora golpéalo

Una vez que tenga una solicitud completa, haga clic en el 'botón Enviar' y vea el código de respuesta. Un código 200 OK significa una operación exitosa. En la imagen a continuación, puede ver que hemos ingresado correctamente a la URL.

El siguiente paso

Ahora, realizaremos otra operación llamada GET. Intentaremos recuperar el mismo registro que acabamos de crear.

No necesitamos un cuerpo o una carga útil para la operación GET. Como ya tenemos nuestra solicitud de muestra utilizando el método PUT, todo lo que necesitamos es cambiar el método a GET.

preguntas de la entrevista c y c ++

Una vez que hayamos cambiado a GET, activaremos el servicio nuevamente. Como puede ver en la imagen de abajo, tenemos exactamente lo que pasamos y así es como funciona el CARTERO.

Actualización: información adicional

¿Qué es una API?

API (Interfaz de programación de aplicaciones) es un archivo jar, que contiene varios métodos e interfaces para realizar una acción en particular.

Consulte el siguiente ejemplo y captura de pantalla:

1. Cree un método de suma, que agrega dos variables y devuelve la suma de dos variables.
2. Luego, cree una clase de calculadora que contenga varios otros métodos, como suma, resta, multiplicación, división, etc. También puede haber algunas clases de ayuda. Ahora combine todas las clases e interfaces y cree un archivo jar llamado Calculator.jar y luego publíquelo. Utilice la API de Calculadora para acceder a los métodos presentes en el interior.
3. Algunas API son de código abierto (Selenium) que se pueden editar y algunas tienen licencia (UFT) que no se pueden editar.

Lectura sugerida => Principales herramientas de gestión de API

¿Cómo se llaman exactamente estos métodos?

Los desarrolladores expondrán una interfaz, una plataforma para llamar a la API de la calculadora y nosotros creamos el objeto de la clase calculadora y llamamos al método suma o cualquier método.

Supongamos que este archivo calculator.jar es creado por alguna empresa y usan esta utilidad a través de la interfaz de la interfaz de usuario, luego probamos esta aplicación de calculadora usando la interfaz de usuario y la automatizamos usando QTP / Selenium y esto se llama Prueba de Front End.

Algunas aplicaciones no tienen UI, por lo tanto, para acceder a estos métodos, creamos un objeto de la clase y pasamos los argumentos para probar y esto se llama Pruebas de back-end . El envío de la solicitud y la recepción de la respuesta se realizará mediante JSON / Archivos XML.

Consulte el siguiente diagrama:

Cliente POSTMAN

• POSTMAN es un cliente REST que se utiliza para realizar pruebas de API de backend.
• En POSTMAN, pasamos la llamada a la API y verificamos la respuesta de la API, los códigos de estado y la carga útil.
• Swagger es otra herramienta de cliente HTTP donde creamos documentación de API y, a través de swagger, también podemos presionar la API y obtener la respuesta.
• Consulte el enlace https://swagger.io/
• Puede usar Swagger o POSTMAN para probar las API, y depende de las empresas qué cliente usar.
• En POSTMAN usamos principalmente llamadas GET, POST, PUT y DELETE.

¿Cómo descargar el cliente POSTMAN?

Abra Google Chrome y descargue la aplicación POSTMAN disponible en la tienda de aplicaciones de Chrome.

Llamar a las API REST mediante el cliente POSTMAN

En POSTMAN tenemos muchos métodos pero solo usamos GET, PUT, POST y DELETE

• CORREO - Esta Convocatoria crea una nueva entidad.
• OBTENER - Esta llamada envía la solicitud y recibe la respuesta.
• PONER - Esta llamada crea una nueva entidad y actualiza la entidad existente.
• ELIMINAR - Esta llamada elimina la entidad existente.

Se puede acceder a las API mediante el uso de una interfaz de usuario como una plataforma bancaria o donde la interfaz de usuario no está disponible como los sistemas de backend donde usamos el cliente de API REST como POSTMAN.

Otros clientes también están disponibles como SOAP UI, que es un cliente REST y SOAP, clientes REST avanzados como JMeter puede llamar a las API directamente desde el navegador. POSTMAN es la mejor herramienta para realizar operaciones POST y GET.

Leer también => Lista de tutoriales detallados de SoapUI

Envíe una solicitud y obtenga una respuesta en POSTMAN Client:

Para fines de prueba, utilizamos las API proporcionadas aquí .

Verifique cada llamada CRUD en el cliente POSTMAN utilizando las API proporcionadas por el sitio ficticio.

En las pruebas de API, validamos principalmente los siguientes puntos:

• Los códigos de estado de respuesta, consulte página wiki para detalles.
• El mensaje de respuesta y el cuerpo de respuesta JSON.
• En las pruebas de API, primero, pida al desarrollador que proporcione la URL del punto final. Vea esta URL de punto final https://reqres.in/.

# 1) OBTENER LLAMADA

Envía la solicitud y recibe la respuesta.

Pasos para probar la API REST:

• Pasar https://reqres.in//api/users?page=2 (? es un parámetro de consulta que filtra el resultado como imprimir toda la información del usuario en la página 2, el parámetro de consulta depende del desarrollador como definirán) como URI en el cliente POSTMAN.
• El parámetro de consulta está definido por (?) Y el parámetro de ruta está definido por (/).
• Seleccione el método GET.

• Proporcione encabezados (si es necesario) como User-Agent: “Software”.

• Haga clic en el botón ENVIAR.
• Si la API funciona bien, en respuesta obtenemos:
  • Estado 200: OK, esto significa que la respuesta se recibió correctamente.
  • Respuesta JSON Payload.
  • Mensaje de cadena

• Otro Ejemplo del GET METHOD, donde buscamos información sobre un usuario específico, es decir, ID de usuario = 3. Ingrese URI = https://reqres.in/api/users/3

• Si los datos no están disponibles para nuestra búsqueda, obtenemos un mensaje de estado JSON y 404 en blanco.

# 2) POST LLAMADA

Crea un nuevo usuario o una entidad.

Pasos para ejecutar:

• Seleccione una publicación POST del menú desplegable y use esta URL de servicio 'https://reqres.in/api/users/100'
  
• Vaya a Cuerpo -> seleccione RAW -> Como estamos pasando JSON.
• Seleccione JSON en el menú desplegable y pegue el script de carga útil.
• Pasa esta carga útil {'nombre': 'Morfeo', 'trabajo': 'líder'}

• JSON comienza con llaves y almacena datos en el formato de clave y valor.
• Pase el tipo de contenido del encabezado = application / json.
• Presione el botón ENVIAR.

• Tras una solicitud exitosa, obtenemos la siguiente respuesta:
  • Estado 201: creado, la respuesta se recibió correctamente.
  • Carga de respuesta
  • Encabezamiento

# 3) PUT Call

Actualiza o crea una nueva entidad.

Pasos para crear una llamada PUT:

• Utilice esta URL de servicio 'https://reqres.in/api/users/206' y la carga útil {'name': 'Morpheus', 'job': 'Manager'
• Vaya al cliente POSTMAN y seleccione el método PUT -> Ir al cuerpo -> Seleccione RAW> pasar JSON y seleccione JSON en el menú desplegable y pegue el script de carga útil.
• JSON comienza con llaves y almacena datos en formato clave-valor.
• Presione el botón ENVIAR, para una solicitud exitosa, obtendrá la siguiente respuesta.
  • Estado 200: Ok, la respuesta se recibió correctamente.
  • Carga de respuesta
  • Encabezamiento
  • Trabajo actualizado a 'administrador'

# 4) Eliminar llamada

• Elimina al usuario, usa esta URL de servicio '/ api / users / 423' y esta carga útil {'name': 'Naveen', 'job': 'QA'}.
• Vaya a POSTMAN y seleccione el método DELETE, no se requiere carga útil.
• Elimina ID de usuario = 423 si está disponible en el sistema.
  • Estado 204: Sin contenido, la respuesta se recibió correctamente.
  • No se recibió carga útil, se eliminó la identificación de usuario
  • Encabezamiento

Desafíos en las pruebas de API

• Los casos de prueba deben diseñarse de tal manera que cubran la cobertura de prueba.
• El diseño de casos de prueba es simple cuando la API tiene menos parámetros, pero la complejidad aumenta cuando la cantidad de parámetros es grande.
• Actualice periódicamente su cobertura de prueba con un cambio en los requisitos comerciales. Si se agrega un nuevo parámetro, aumente el conjunto de arnés de prueba
• Secuenciar correctamente las llamadas a la API.
• Explore las condiciones de contorno y el rendimiento.

Conclusión

En este tutorial, discutimos los consejos importantes para comenzar con la herramienta de prueba Postman API. Aprendimos a instalar la herramienta Postman como una aplicación independiente y discutimos cómo podemos crear una solicitud simple y observar la respuesta generada.

Vimos cómo navegar a las diferentes partes de la información de respuesta, así como también cómo revisar y recuperar las solicitudes de la pestaña del historial.

Creemos que a estas alturas, puede realizar una operación exitosa en una API. La operación exitosa en una API no significa copiar y pegar todo el cuerpo, encabezados y otros bloques necesarios y hacer que la ejecución de la prueba sea exitosa.

Se trata de lo cómodo que se siente al escribir su propio JSON, navegar a cualquier campo en particular en un JSON con la ayuda de la clave del documento o los parámetros, comprender las matrices en JSON, etc.

La herramienta cliente POSTMAN se utiliza para realizar pruebas de back-end y principalmente para realizar llamadas GET, PUT, POST, DELETE.

De este tutorial, aprendimos cómo acceder a las llamadas del cliente POSTMAN y cómo validar la respuesta que obtenemos del servidor y también cubrimos los desafíos en las pruebas de API.

Las pruebas de API son muy importantes para encontrar lagunas en las API, ya que los piratas informáticos las explotarán y causarán pérdidas financieras. Las pruebas de API parecen simples, pero debemos ser muy cautelosos e intentar probar con todas las combinaciones posibles.

En nuestro próximo tutorial, aprenderemos cómo usar la herramienta Postman para formatos API Diff.

PREV Tutorial | SIGUIENTE Tutorial

Lectura recomendada

• Tutorial de Parasoft SOAtest: Herramienta de prueba de API sin script
• Tutorial de pruebas de API: una guía completa para principiantes
• Mejores herramientas de prueba de software 2021 (Herramientas de automatización de pruebas de control de calidad)
• Tutorial de pruebas destructivas y no destructivas
• Pruebas funcionales versus pruebas no funcionales
• Tutorial de la herramienta de prueba de accesibilidad WAVE
• Tutorial de pruebas de accesibilidad (una guía completa paso a paso)
• Tutorial de pruebas SOA: metodología de prueba para un modelo de arquitectura SOA