Hoppscotch: herramienta open source para API testing

Esta herramienta para API Testing intuitiva y fácil de usar, es ideal para crear y utilizar peticiones de forma rápida, al consumir muy pocos recursos en tiempo real.

En este post compartiré lo que estuve aprendiendo de Hoppscotch, sus principales características y diferencias con otras herramientas similares.

¿Qué es Hoppsctoch?

Hoppscotch es una herramienta para API testing gratuita, de código abierto y muy liviana para crear y utilizar peticiones de forma rápida. Está disponible a través de una web app y también posee una versión PWA (aplicación web progresiva) y si bien no requiere registro para probar el servicio, es conveniente para guardar los resultados en la nube.

Hoppscotch ofrece una interfaz de usuario donde podemos encontrar soporte para Rest, WebSocket y GraphQL. Puedes enviar fácilmente solicitudes a las API en diferentes entornos utilizando variables de entorno de Hoppscotch.

El enfoque para las pruebas es similar al de Postman, un editor de código simple para escribir casos de prueba en Javascript.

Comparativa de las Herramientas de API Testing: Hoppscotch, Postman y SoapUI

En la siguiente tabla, se comparan las principales características de Hoppsctoch con su principal alternativa, Postman y se agrega SoapUI para ver sus diferencias.

Tabla comparativa de las herramientas de API Testing más populares: Hoopscotch, Postman y SoapUI.

Mi experiencia con Hoppscotch

Mis primeras pruebas con la herramienta fueron para este review. Las mismas fueron realizadas contra la API que provee Swagger llamada PetStore.

Como mencioné anteriormente, se puede usar tanto su versión web como aplicación web progresiva, en mi caso opté por instalar ésta última, ya que es muy sencilla e intuitiva de usar.

Al ingresar a la aplicación en hoppscotch.io, se muestra la opción para instalarla localmente, lo cual es muy fácil de hacer. Realmente no es necesario configurar la aplicación en ningún sentido, más que iniciar sesión con alguna de las opciones disponibles, para poder guardar el espacio de trabajo en la nube.

A continuación, dejo algunas capturas de pantalla tomadas durante las pruebas para mostrar cómo luce la herramienta.

Lo primero que hice fue crear las colecciones para organizar y almacenar las distintas peticiones:

Otra acción que se puede realizar con las colecciones es exportarlas como JSON. Como se aprecia en la imagen, también permite colecciones compartidas entre equipos.

En las peticiones, se pueden usar parámetros o pasar datos mediante las variables de entorno:

En la sección de pruebas, se pueden usar los snippets que ofrece la herramienta (Ej: validar que el código de estado es 200):

La generación de la documentación es realmente sencilla de realizar, vamos al apartado de Docs, seleccionamos o importamos las colecciones que deseamos incorporar y presionamos “Generar documentación”:

Generación de documentación en la herramienta Hoppscotch.

Para crear un Gist con la documentación generada es necesario iniciar sesión con GitHub.

Pros

A pesar de ser una herramienta relativamente nueva, se lanzó en 2019, según la comunidad en GitHub, actualmente está siendo usada por más de 750 mil desarrolladores alrededor del mundo y cuenta con más de 50 mil usuarios mensuales, lo que la ha convertido en una herramienta a tener en cuenta para API Testing.

Ventajas de Hoppscotch

Ligera y rápida.
Generador de documentación.
Soporte para WebSocket permite también SSE, Socket.IO y MQTT (Imagen 1).
Soporte dedicado a GraphQL permite ver y crear solicitudes fácilmente (Imagen 2).
Características en aumento gracias a la colaboración de la comunidad.

Contras

Por la misma razón que Hoppscotch es elegida por miles de usuarios, por tratarse de una herramienta relativamente nueva, puede presentar algunos inconvenientes.

Desventajas de Hoppscotch

Poca documentación.
Faltan características para la automatización de pruebas.
Necesidad de agregar algunas características por CLI.

¿Cuándo y por qué usar la Herramienta Hoppscotch?

Para proyectos que requieran pruebas manuales y ágiles, Hoppscotch es la herramienta ideal.

Como el propio creador de Hoppscotch, Liyas Thomas lo ha dicho en el blog dev.to, es una herramienta que corre online, consume muy pocos recursos, soporta múltiples plataformas así como dispositivos y está accesible desde cualquier lugar. En sus propias palabras: “No existe otra herramienta tan simple, minimalista y eficiente”.

Otra de las características que hace a Hoppscoth interesante es que se puede personalizar: desde el fondo, color de acentuación, tamaño de fuente, idioma y otras características que van mejorando con la colaboración de la comunidad.

Personalización de la herramienta Hoppscotch

También es posible configurar middleware entre la aplicación y las APIs, ya sea mediante el uso de Proxy o agregando las extensiones para Chrome o Firefox:

Extensiones para Chrome y Firefox de la Herramienta Hoppscotch

En el siguiente diagrama se muestra cómo funciona el ProxyScotch:

ProxyScotch de la herramienta Hoppscotch

Por último, para aquellos a quienes les interese entender más de Hoppscotch pueden revisar los siguientes repositorios:

Hoppscotch: Ecosistema de desarrollo de API.
Docs: Documentación Hoppsctoch.
Hopp-doc-gen: CLI para generar documentación de una API.
Hoppscotch-extension: Extensiones para el navegador.
.github: Ecosistema de desarrollo de API de código abierto.
Hopp-cli: Cliente HTTP CLI.
ProxyScotch: Servidor Proxy.
Hopp-js-sandbox: Sandbox para scripts JS externos en entornos que utilizan los clientes de Hoppscotch.

Reflexiones finales

Hoppscotch es una herramienta 100% gratuita y según su creador, siempre lo será. Es sencilla e intuitiva de usar. Consume muy pocos recursos en tiempo real siendo ideal en dispositivos de baja gama y volviéndose muy ágil en cualquier dispositivo.

Si bien aún está en proceso de desarrollo, al ritmo que se vienen incrementando sus características, no sería extraño que en poco tiempo veamos funcionalidades para automatización de pruebas que le estarían faltando para equipararse con su equivalente Postman.