En un mundo en el que los sitios web y las aplicaciones estáticos dependen cada vez más de API mantenidas por separado, puede ser difícil descubrir cómo funcionan simplemente jugando en el navegador.
Entonces, ¿cómo podemos usar Postman para probar nuestras API existentes y comprender cómo funcionan?
- ¿Qué es Postman?
- ¿Qué vamos a construir / aprender?
- Parte 0: Configuración con Postman
- Parte 1: Introducción a Postman
- Parte 2: Creación de una nueva solicitud de Postman para OBTENER información sobre Squirtle
- Parte 3: Crear una colección de solicitudes en Postman para la PokéAPI
- Parte 4: Realizar solicitudes POST con Postman para traducir oraciones para que suenen como Yoda
- Parte 5: Autenticación de solicitudes a la API de Lord of the Rings con una clave API
¿Qué es Postman?
Postman es una herramienta que los equipos pueden usar para probar API de manera confiable mediante configuraciones fáciles de usar. Viene con características que esperaría cuando se trata de API, incluida la autenticación, la configuración de encabezados, la personalización de la carga útil y muchas más que ayudan a reducir la fricción del uso de una API.
Y no es solo para probar. Lo bueno es que esto se puede utilizar para muchos aspectos del trabajo con API para muchos miembros diferentes del equipo. Tal vez un gerente de proyecto quiera verificar que las cosas funcionen o que le resulte más fácil hacer un cambio directamente con la API, o un ingeniero de control de calidad necesita asegurarse de que todo funcione, o un desarrollador quiera realizar cambios activamente mientras trabaja en la propia API. .
La mejor parte: Postman ofrece funciones de colaboración. El nivel gratuito incluye exportar e importar colecciones de solicitudes de API guardadas, así como crear enlaces compartidos. Si eres parte de un equipo, tienen niveles pagados que te permiten sincronizar tus colecciones para asegurarte de que todos tengan la colección más reciente y actualizada.
¿Qué vamos a construir / aprender?
Veremos dos API de ejemplo diferentes para cubrir los conceptos de Postman.
Primero, analizaremos algunas solicitudes HTTP simples con una API pública para Pokémon.
Luego, usaremos la API de Yoda Translator para una parte para demostrar cómo realizar solicitudes HTTP específicas.
Una vez que entendamos cómo funcionan los conceptos básicos, usaremos la API de Lord of the Rings para aprender cómo funciona la autenticación con las API. Para ello, deberá registrarse para obtener una cuenta gratuita para una clave API.
Parte 0: Configuración con Postman
Antes de comenzar, necesitará Postman para seguir este tutorial. La buena noticia es que Postman está disponible de forma gratuita en Mac, Windows y Linux, por lo que debería poder encontrar una versión que funcione para usted.
Obtenga Postman: //www.postman.com/downloads/
Una vez descargado, siga las instrucciones de instalación estándar, ábralo y ¡deberíamos estar listos para comenzar!
Parte 1: Introducción a Postman
La primera vez que abra Postman, se le mostrará inmediatamente una plataforma de lanzamiento con un montón de opciones para comenzar.
Puede parecer un poco abrumador, pero analicemos algunos de los conceptos clave que necesitaremos saber.
Peticiones
Una solicitud es lo que parece, es una solicitud API específica. Este será un solo tipo de solicitud, ya sea GET o POST a un punto final específico. Querrá crear nuevas solicitudes para cada tipo de punto final, lo que le permitirá moverse entre ellos durante la prueba.
Colecciones
Una colección es un grupo de solicitudes. Esto es útil para organizar sus solicitudes en diferentes grupos. Esto podría ser tan simple como dos API totalmente diferentes (es decir, Twitter vs Slack) o podrían ser dos grupos diferentes de API para una sola API (es decir, API de Twitter Tweets vs API de cuentas de Twitter).
Autorización
La autorización es cómo se autentican las solicitudes con una API, ya sea por una persona que realiza una solicitud o por una computadora que realiza esa solicitud en su nombre. Esto comúnmente se presenta en forma de una clave API que puede ser un valor estático asignado a su cuenta o generada dinámicamente con herramientas como OAuth.
Ambientes
Los entornos le permitirán configurar sus puntos finales para utilizar variables específicas que faciliten el uso de los mismos puntos finales entre diferentes entornos. Por ejemplo, puede tener el mismo /profilepunto final en sus entornos de producción y desarrollo, pero tienen dominios diferentes. Entornos te permite gestionar una única solicitud con un dominio variable.
Espacios de trabajo
No vamos a ir demasiado lejos en los espacios de trabajo en esta publicación, pero le permite administrar y organizar diferentes conjuntos de colecciones. Imagine que si desea utilizar Postman tanto para el trabajo como para un proyecto personal, es posible que tenga un espacio de trabajo de trabajo y un espacio de trabajo personal.
Para los propósitos de este artículo, cubriremos Solicitudes, Cobros y Autorizaciones.
Parte 2: Creación de una nueva solicitud de Postman para OBTENER información sobre Squirtle
Ahora que comprendemos mejor la terminología diferente, creemos una solicitud.
En la parte superior izquierda de la interfaz de usuario, debería ver un botón naranja que dice Nuevo . Continúe y haga clic en eso y luego seleccione Solicitar .
Antes de entrar en la solicitud en sí, solicita algunas cosas.
Lo primero que requiere es un nombre. Comenzaremos solicitando información sobre el Pokémon Squirtle, así que llamemos a este "Pokémon - Squirtle".
También requiere una colección, así que haz clic en Crear colección y vamos a nombrar la colección "Mi Pokémon favorito".
Haga clic en el botón de marca de verificación naranja junto al nombre de la colección y luego presione Guardar .
En este punto tendremos una nueva solicitud, así que compilemos esa solicitud.
Hay dos cosas que primero debemos completar para nuestra primera solicitud:
- Tipo de solicitud: GET, POST, PUT, etc; usaremos GET
- URL de solicitud: el punto final de su solicitud de API; para nuestra solicitud usaremos //pokeapi.co/api/v2/pokemon/squirtle/
Y una vez que se asegure de que son correctos, simplemente presione el botón azul Enviar a la derecha y ¡hemos realizado nuestra primera solicitud correctamente!
Inmediatamente obtenemos algunas cosas que podemos ver:
- Cuerpo: en la parte inferior ahora deberíamos ver el cuerpo de respuesta de la solicitud de API. Para nuestra API Squirtle, debemos tener un objeto JSON con datos como
abilities,base_experience, yforms. - Estado: a la derecha, deberíamos ver el código de estado HTTP. “200 Ok” es una buena señal y significa que fue exitoso.
- Tiempo: simplemente cuánto tiempo tardó la solicitud en finalizar
- Tamaño: el tamaño en KB (en nuestro ejemplo) de los datos de respuesta
También puede colocar el cursor sobre Estado, Tiempo y Tamaño y obtener una visión más detallada de cada opción.
¡Así que hicimos nuestra primera solicitud!
Una cosa a tener en cuenta antes de continuar es que nuestra solicitud parece estar en una pestaña del navegador. Si hemos terminado con esa solicitud en particular, podemos cerrar la pestaña y hacer clic en Guardar para asegurarnos de que todos nuestros cambios estén ahí para la próxima vez.
Parte 3: Crear una colección de solicitudes en Postman para la PokéAPI
Ahora que hemos creado una solicitud, creemos una colección de ellos. Técnicamente, ya teníamos que crear una nueva colección para la Parte 2, pero crearemos una nueva para aprender cómo funcionan las colecciones.
En la parte superior izquierda de la interfaz de usuario, vuelva a hacer clic en el botón naranja Nuevo y seleccione Colección .
Similar a una solicitud, pide un nombre, así que llamemos a esto "PokéAPI". Opcionalmente, puede agregar una descripción y luego hacer clic en Crear en la parte inferior.
A la izquierda, ahora verá su colección. Puede seleccionar y expandir la carpeta ya que estaremos trabajando con ella.
Antes de agregar una solicitud, la PokéAPI tiene diferentes tipos de solicitudes, por lo que tiene sentido organizarla un poco más a fondo. Así que hagamos clic en los tres puntos junto a la colección PokéAPI y seleccione Agregar carpeta .
Al igual que los demás, este pide un nombre. Las carpetas son una especie de colecciones dentro de una colección, por lo que obtienes opciones similares. Llamemos a este "Pokémon" y hagamos clic en el botón naranja Guardar como antes.
¡Ahora agreguemos nuestras solicitudes! Primero, haga clic en los tres puntos al lado de la carpeta Pokémon, de manera similar a como agregamos una carpeta a la colección, pero esta vez seleccione Agregar solicitud .
Llamemos a esta solicitud "Pokémon". Si bien puede resultar confuso que tengamos una solicitud de Pokémon dentro de la carpeta Pokémon, Pokémon es solo uno de los puntos finales del grupo Pokémon.
Ahora, usemos exactamente la misma API que usamos con nuestra solicitud de Squirtle antes:
- Tipo de solicitud: OBTENER
- URL de solicitud: //pokeapi.co/api/v2/pokemon/squirtle/
Y al igual que antes, cuando presionamos el botón azul Enviar , deberíamos ver una solicitud exitosa.
Ahora agreguemos otra solicitud. Siga el mismo proceso que antes para crear una nueva solicitud en la carpeta Pokémon PokéAPI y nombremos esta solicitud "Habilidades".
Si se desplaza por la respuesta desde el primer punto final de Squirtle, verá muchas otras URL de API. En la parte superior, tenemos abilitiesy tenemos dos diferentes: "torrente" y "plato de lluvia".
Elige tu habilidad favorita de Squirtle y copia el urlvalor en la nueva solicitud de habilidades que acabamos de crear, que voy a usar rain-dish.
Podemos dejar el tipo de solicitud como GET, presionar el botón azul Enviar y nuevamente podemos ver una respuesta exitosa.
Aquí obtenemos mucha información sobre nuestra habilidad de Squirtle Rain Dish y algunos de los detalles vienen en diferentes idiomas, ¡lo cual es genial!
Así que ahora tenemos una nueva colección de PokéAPI con una carpeta de Pokémon que representa el grupo de puntos finales de la API de Pokémon, incluidos Pokémon y habilidades.
Vamos a detener la Parte 3 con esas 2 solicitudes, ¡pero siéntete libre de continuar y agregar tantas solicitudes de PokéAPI como quieras!
Parte 4: Realizar solicitudes POST con Postman para traducir oraciones para que suenen como Yoda
Hasta ahora solo hemos realizado solicitudes GET, pero ¿y si quisiéramos hacer una solicitud POST donde realmente necesitamos enviar algunos datos?
Para realizar una solicitud POST, usaremos la API de Yoda Translator de funtranslations.com. Si bien esta API solo toma un único parámetro, sigue siendo un buen punto final público que podemos usar para comprender el concepto.
Primero, creemos una nueva colección con una nueva solicitud:
- Colección: Fun Translations
- Solicitud: Yoda
Esta vez, en lugar de una solicitud GET, nuestra configuración de solicitud será:
- Tipo de solicitud: POST
- Solicitar URL: //api.funtranslations.com/translate/yoda
Ahora bien, esta vez, si presionamos el botón azul Enviar , notaremos que no obtenemos una respuesta exitosa de 200, ¡obtenemos un 400!
En realidad, nunca configuramos ningún dato para que se publique en la API y requiere esos datos, así que agregémoslo.
Justo debajo de la URL de solicitud , haga clic en Cuerpo . Luego, en lugar de ninguno, seleccione raw como tipo de cuerpo. Finalmente, en el extremo derecho de los tipos, cambie Text a JSON .
Luego, en el espacio debajo de él, puede agregar lo siguiente:
{ "text": "Hello, I am learning how to test APIs with Postman!" } ¡Y ahora haz clic en el botón azul Enviar nuevamente y obtenemos una respuesta exitosa!
Podemos aplicar este concepto a prácticamente cualquier API. Postman no solo le permite publicar JSON, sino que también le permite usar los otros formatos que vemos enumerados en la sección Tipo de cuerpo, lo que significa que tiene muchas opciones dependiendo de lo que requiera la API que esté utilizando.
Parte 5: Autenticación de solicitudes a la API de Lord of the Rings con una clave API
Para el resto del tutorial, usaremos la API de El señor de los anillos.
En primer lugar, la API de Lord of the Rings requiere autenticación para realizar solicitudes utilizando una clave de API. Entonces, para comenzar, antes de sumergirnos, deberá crear una cuenta gratuita.
//the-one-api.herokuapp.com/sign-up
Una vez que se registre e inicie sesión, lo primero que verá es su clave API. Copie esta clave o recuerde dónde puede encontrarla para más adelante. Si abandona la página, siempre puede tomarla navegando a Bienvenido y luego a Cuenta en la navegación del sitio web de la API.
Para comenzar, primero creemos una nueva colección y solicitemos:
- Colección: El señor de los anillos
- Carpeta: Película
- Solicitud: todas las películas
- Tipo de solicitud: OBTENER
- URL de solicitud: //the-one-api.herokuapp.com/v1/movie
Una vez que esté configurado con lo anterior, haga clic en Enviar , y notará inmediatamente que da una respuesta que dice 401 y que no está autenticado.
Debido a que esta API requiere la clave de API, esto es exactamente lo que esperábamos. Entonces hagamos clic en la pestaña Autorización . Luego podemos seleccionar un tipo de token de portador y, a la derecha, podemos pegar nuestra clave que acabamos de configurar con la API de Lord of the Rings.
¡Y tan pronto como presionamos Enviar , ahora vemos una respuesta exitosa!
Esto funcionó muy bien, pero ¿qué pasa si tenemos un montón de solicitudes que usan una sola clave? ¿Tenemos que gestionar eso en cada solicitud?
En lugar de administrarlo en cada solicitud individual, podemos administrarlo en la colección. Primero construyamos otra solicitud.
En nuestra colección El señor de los anillos y en la carpeta Película, cree una nueva solicitud:
- Solicitud: cotización por ID de película
- Tipo de solicitud: OBTENER
- URL de solicitud: //the-one-api.herokuapp.com/v1/movie/{id}
En esta solicitud, usemos un ID de la respuesta de la primera solicitud, voy a usar 5cd95395de30eff6ebccde5bcuál es el ID de The Two Towers, por lo que la URL de la solicitud se verá así:
//the-one-api.herokuapp.com/v1/movie/5cd95395de30eff6ebccde5b
Ahora, en lugar de configurar nuestro token en la autorización de solicitud, dejaremos el tipo como Heredar autenticación de padre . Haga clic en los tres puntos junto a la colección y seleccione Editar .
Aquí, vamos a hacer exactamente lo mismo que hicimos con la primera solicitud, pero en la configuración de la Colección. Seleccione la pestaña Autorización , en el tipo seleccione Bearer Token , y en el campo Token vuelva a pegar su token.
Finalmente, haga clic en Actualizar y presione el botón azul Enviar nuevamente y podremos ver una solicitud exitosa.
Ahora podemos volver a nuestra solicitud de Todas las películas y actualizar la Autorización para usar un Tipo de autenticación heredada de los padres, ¡y aún debería seguir funcionando!
¿Qué más podemos hacer con Postman?
Si bien cubrí muchos de los conceptos básicos, hay mucho más que puedes hacer con Postman. Aquí están algunos de mis favoritos.
Variables de entorno
Si trabaja como desarrollador en un proyecto, es probable que su equipo utilice varios entornos, como un entorno de desarrollo y producción. En lugar de crear y mantener solicitudes completamente separadas, puede agregar una variable de entorno y, en su lugar, cambiar esa variable al cambiar entre entornos.
Las variables se aplican a muchos escenarios, pero ese es un uso común. Consulte los documentos de Postman para aprender cómo.
//learning.postman.com/docs/postman/variables-and-environments/variables/
Importar y exportar colecciones y datos
Una gran cosa sobre Postman es que una vez que tenga todas sus solicitudes organizadas, puede exportarlas para que otras personas las usen. Esto también significa que puede importar colecciones de otros miembros del equipo. Esto hace que sea mucho más fácil asegurarse de que todos usen la misma colección.
Bonificación: incluso puede almacenar estos archivos en un repositorio de Git, ya que son solo JSON.
Pero tenga en cuenta que si está utilizando la Autorización en la colección, como analizamos en esta guía, debe asegurarse de no incluirla al exportar su colección.
//learning.postman.com/docs/postman/collections/importing-and-exporting-data/
Prueba automatizada
Una vez que tenga un conjunto de solicitudes en una colección y aún mejor, si las está almacenando en Github, puede comenzar a usar esas solicitudes como parte de una forma de administrar las pruebas automatizadas de su API.
Si bien hay algunas soluciones para hacer esto, Postman incluye un corredor de colección integrado directamente en la aplicación y Newman es una herramienta de línea de comandos que le permite ejecutar pruebas directamente desde la terminal.
//www.postman.com/use-cases/api-testing-automation/
¿Cuál es tu forma favorita de probar y jugar con las API?
¡Comparte conmigo en Twitter!
- ? Sigueme en Twitter
- ? ️ Suscríbete a mi Youtube
- ✉️ Suscríbete a mi boletín