¿Qué es Postman?

Hoy comenzamos una nueva serie de tutoriales sobre Postman. ¿Qué es? ¿Qué os puede ofrecer? ¿Por dónde empezar? Postman mola por muchos motivos… ¡hasta por el nombre!

Postman

Se trata de una herramienta dirigida a desarrolladores web que permite realizar peticiones HTTP a cualquier API. Postman es muy útil a la hora de programar y hacer pruebas, puesto que nos ofrece la posibilidad de comprobar el correcto funcionamiento de nuestros desarrollos.

Con esto no queremos decir que Postman sea una herramienta exclusiva para profesionales del entorno web, de hecho va a ser muy útil para todo aquel que tenga que interactuar con una API.

Imaginate que un día te levantas curioso y quieres ver qué hace la API de Spotify. Si navegas a su web podrás encontrar documentación, pero comprenderás más y mejor cómo funciona y qué te ofrece si lo pruebas por ti mismo.

Fuera de su objetivo principal, hacer peticiones a servicios, nos ofrece un conjunto de funcionalidades que nos ayudarán a organizar las peticiones en colecciones, hacer y automatizar pruebas, mantener equipos sincronizados y crear Mocks de APIs.

Todo esto es gratis en su versión básica pero además ofrece dos posibilidades de pago que mejoran las características, permitiendo la sincronización entre miembros de un equipo, creación de mocks sin límites, monitorización de entornos, etc.

Colecciones

Postman nos ofrece la posibilidad de guardar y agrupar conjuntos de solicitudes en lo que ellos denominan “Collections”, es decir simples carpetas en distintos niveles que organizarán nuestras peticiones HTTP.

Variables de entorno

Como en todos los lenguajes de programación, las variables son símbolos que guardan valores y para esto mismo sirven en Postman. Aunque a priori pueda parecerte que no tiene mucho sentido para una herramienta así, lo cierto es que esto aumenta su potencial enormemente.

El uso de variables nos ayuda a la realización de pruebas, al cambio entre distintos entornos (entorno de desarrollo, pruebas, producción, etc.) y, en general, nos ayuda a recordar y evitar escribir el mismo texto o ruta de forma repetitiva.

Documentación de APIs

Una parte fundamental de la creación y uso de una API es disponer de una documentación completa y bien estructurada. Postman genera esta documentación de forma automática, utilizando la información de las peticiones y las descripciones que hayas introducido al crearlas.

La documentación puede ser pública o privada, teniendo un límite de 1000 visualizaciones al mes en su versión básica. Además, junto a la documentación generada, muestra cómo deben implementarse las peticiones a la API en distintos lenguajes de programación, algo muy útil a la hora de desarrollar.

Automatización de pruebas

Si lo que buscas es una herramienta que te ayude a automatizar las pruebas sobre tu código, Postman es lo que buscas. Ofrece varias posibilidades que te permiten ejecutar conjuntos de pruebas, más o menos complejas.

La opción más sencilla es utilizar el Collection Runner, que a partir de una colección que definas, ejecuta ese conjunto de peticiones el número de veces que establezcas. Además si defines Test específicos en las request, podrás hacer pruebas más complejas que reproduzcan la combinación de varias operaciones. Al ejecutarlo, mostrará el resultado de las pruebas con un resumen, indicando el tiempo de respuesta y el estado HTTP devuelto por el servidor.

También existe NewMan, un Add-on que permite ejecutar los test a través de línea de comandos, algo que será de especial utilidad en entornos de integración. Está preparado para trabajar con Jenkins, Travis y Docker.

Puesta en marcha

Si llegados a este punto te ha picado la curiosidad y quieres probar Postman, sigue leyendo y da el primer paso para poder trabajar con esta herramienta.

Instalación

Antes de nada, si todavía tienes instalado una extensión de Chrome llamada Postman en tu navegador este es el momento para que la desinstales e instales la aplicación nativa Postman, puesto que la extensión ya no se mantiene ni actualiza.

La aplicación Postman está disponible para los sistemas operativos Mac, Windows y Linux. Podemos descargar la app en su página oficial haciendo click en el sistema en el que estéis trabajando.

Una vez descargado el archivo solo tendremos que ejecutarlo para que comience la instalación, no tiene ningún misterio :-).

Cuenta y Sincronicación

Una vez instalado, podrás identificarte en la aplicación con tu usuario y contraseña, si ya tenías una cuenta en Postman. En cuanto accedas se sincronizará todo tu historial y tus colecciones.
Pero si aún no estás registrado, te animamos a que lo hagas puesto que es gratis, solo te llevará 5 minutos y ofrece algunas funcionalidades muy interesantes:

• Sincronización de colecciones.
• Sincronización del historial.
• Creación de enlaces a tus colecciones de Postman.

Si por algún casual ya estabas utilizando Postman pero no tenías una cuenta creada y decides hacerlo ahora, no temas perder toda la información que ya has generado. Puedes exportar la información e importarla una vez hayas iniciado sesión con tu nueva cuenta.

Además puede resultar interesante saber que puedes tener sesión iniciada con varias cuentas al mismo tiempo, algo muy útil si tienes una cuenta para el trabajo, otra personal, etc.

Primer ejemplo

Hasta ahora hemos visto qué es Postman y todo lo que ofrece esta fantástica herramienta. Es el momento de pasar a la acción y hacer uso de su funcionalidad principal.

Una vez abierto el programa podemos observar que es una mezcla entre un IDE, con un panel a la izquierda donde se puede navegar por colecciones e historial, y un navegador web, con un visor organizado por pestañas.

Para crear nuestra primera petición pulsaremos en la barra de direcciones situada en el panel derecho que nos dice Enter request URL. Aquí escribiremos la URL a la que queramos realizar una petición.

Para este ejemplo hemos buscado una API que fuera gratuita, sin autenticación y de una empresa conocida. Hemos decidido usar la API que provee Apple para hacer búsquedas de contenido en iTunes.

Haremos una búsqueda de un video musical del grupo ACDC. Revisando la documentación hemos formado la siguiente URI:

https://itunes.apple.com/search?term=acdc&entity=musicVideo&limit=1

Esta URI la introduciremos en la barra de direcciones. Dejaremos marcado el método GET (si la API requiriese otro método REST podríamos cambiarlo aquí) y pulsaremos sobre el botón Send. La respuesta que nos proporciona el servidor se mostrará en el panel inferior, donde podremos ver el mensaje en detalle.

Conclusiones

Con todo lo que te hemos contado sobre Postman no nos cabe ninguna duda de que empezarás a usarlo hoy mismo.

Nuestra idea es profundizar en cada uno de los puntos que hemos mencionado en futuros artículos, si tenéis alguna propuesta o idea os animamos a que nos dejéis un comentario o contactéis con nosotros. Será de gran ayuda para todos.