Insomnia es una aplicaci\u00f3n de escritorio multiplataforma gratuita que simplifica la interacci\u00f3n y el dise\u00f1o de API basadas en HTTP<\/strong>. Insomnia combina una interfaz f\u00e1cil de usar con funciones avanzadas como asistentes de autenticaci\u00f3n, generaci\u00f3n de c\u00f3digo y variables de entorno.<\/p>\n\n\n En la siguiente tabla, se comparan las principales caracter\u00edsticas de Insomnia con Postman<\/strong> y SoapUI<\/strong> para ver similitudes y diferencias.<\/p>\n\n\n Mis primeras pruebas con la herramienta fueron para este review, y el objetivo de las mismas era entender con qu\u00e9 caracter\u00edsticas cuenta Insomnia as\u00ed como tambi\u00e9n conocer de primera mano c\u00f3mo maneja tanto APIs REST como SOAP, por lo tanto, dichas pruebas fueron realizadas contra las APIs GoREST<\/a> y CountryInfoService<\/a>.<\/p>\n\n\n\n Anteriormente, vimos c\u00f3mo funciona Hoppscotch<\/a>, ecosistema de desarrollo de API de c\u00f3digo abierto, ahora queremos entender c\u00f3mo se comporta Insomnia probando una API Rest en comparaci\u00f3n con Postman y una API Soap en comparaci\u00f3n con SoapUI.<\/p>\n\n\n\n A continuaci\u00f3n, comparto algunas capturas de pantalla tomadas durante las pruebas para mostrar c\u00f3mo luce la herramienta. Luego de descargarla e instalarla, su uso es realmente intuitivo, ya que presenta una interfaz muy similar a Postman.<\/p>\n\n\n\n GoRest es una API Rest que est\u00e1 disponible en l\u00ednea para pruebas y prototipado. Permite el registro de usuarios los que pueden publicar post y comentarios. Como se trata de una API para pruebas solo contiene datos falsos.<\/p>\n\n\n\n Para comenzar con las pruebas sobre GoREST, cree un proyecto en el dashboard de Insomnia:<\/p>\n\n\n Lo primero que hice fue configurar el ambiente de trabajo. Para ello vamos al men\u00fa de ambientes y seleccionamos la opci\u00f3n Manage Environments <\/strong>o Ctrl+E<\/strong>:<\/p>\n\n\n En el gestor de ambientes desplegamos las opciones en Sub Environments<\/strong> y seleccionamos Environment<\/strong>:<\/p>\n\n\n Con el nuevo ambiente creado, podemos hacer clic sobre el nombre para editarlo y comenzar a escribir los par\u00e1metros en formato JSON:<\/p>\n\n\n Una vez creado el ambiente, debemos seleccionarlo de la lista desplegable:<\/p>\n\n\n Dentro del ambiente, creamos las colecciones para organizar y almacenar las distintas peticiones:<\/p>\n\n\n A diferencia de Postman o SoapUI, las colecciones o folders no se exportan directamente desde el men\u00fa contextual, sin embargo, en Settings <\/strong>se puede mover o copiar hacia otro Workspace.<\/p>\n\n\n Para importar o exportar cualquier documento o colecci\u00f3n del workspace vamos al men\u00fa que se despliega en su nombre y seleccionamos Import\/Export<\/strong>:<\/p>\n\n\n Como en herramientas similares, en las peticiones se pueden usar par\u00e1metros mediante las variables de entorno, definidas en formato JSON.<\/p>\n\n\n\n Para invocar cualquier par\u00e1metro presionamos Ctrl+Espacio<\/strong> donde se desea insertar el mismo y se despliega una lista con todas las variables disponibles.<\/p>\n\n\n Tambi\u00e9n es posible indicar el par\u00e1metro directamente en la secci\u00f3n Query <\/strong>del pedido:<\/p>\n\n\n En el caso de enviar una petici\u00f3n de tipo POST, como en otras herramientas, se puede seleccionar el tipo de Body<\/em><\/strong> (JSON, XML, YAML, EDN, Plain, Binary File, No Body):<\/p>\n\n\n En el caso de la API que estamos probando, es necesario enviar un token de autorizaci\u00f3n que se puede agregar en la secci\u00f3n Auth <\/strong>seleccionando el tipo de autorizaci\u00f3n<\/a> requerida:<\/p>\n\n\n Insomnia permite realizar peticiones a partir de cURL. Para ello copiamos una de las cURL que ofrece la API GoRest como ejemplo y la pegamos en la URL de la petici\u00f3n:<\/p>\n\n\n Al pegar la cURL se visualiza autom\u00e1ticamente la URL:<\/p>\n\n\n Asimismo, es posible enviar archivos adjuntos si seleccionamos Binary File<\/strong> en el Body:<\/p>\n\n\n Luego de seleccionar el archivo, la petici\u00f3n lucir\u00e1 as\u00ed:<\/p>\n\n\n El resultado se puede ver en la parte derecha de la pantalla de la siguiente manera:<\/p>\n\n\n Otra caracter\u00edstica compartida con otras herramientas es el historial de respuestas sobre la derecha para poder tener trazabilidad de nuestro trabajo:<\/p>\n\n\n Es un servicio web que muestra informaci\u00f3n del pa\u00eds a partir de un c\u00f3digo ISO de dos letras, por ejemplo UY. Ofrece funciones para recuperar la moneda utilizada, el idioma, la ciudad capital, el continente y el c\u00f3digo de tel\u00e9fono.<\/p>\n\n\n\n Para comenzar, cre\u00e9 otro proyecto en el dashboard de Insomnia. Tambi\u00e9n configur\u00e9 el ambiente y las colecciones del nuevo proyecto:<\/p>\n\n\n Para los pedidos del tipo SOAP, lo que hacemos es seleccionar XML <\/strong>como tipo de Body y darle el formato correspondiente (XML):<\/p>\n\n\n Un dato que me pareci\u00f3 importante: debemos seleccionar el m\u00e9todo POST ya que si bien es posible usar GET en los web services Soap<\/a>, t\u00edpicamente dado que dicho protocolo utiliza payloads verbosos se suele utilizar POST. Adem\u00e1s, es necesario tambi\u00e9n configurar los headers:<\/p>\n\n\n Y obtenemos la respuesta:<\/p>\n\n\n Si preferimos pasar datos como par\u00e1metros en el pedido, tambi\u00e9n podemos hacerlo:<\/p>\n\n\n Insomnia permite extraer valores de las respuestas para ser usados en otros pedidos. Por ejemplo, usar el ID de la respuesta de un m\u00e9todo POST en un pedido del tipo GET. Se puede ver esta Documentaci\u00f3n<\/a> para mayor informaci\u00f3n.<\/p>\n\n\n\n Existen tres tipos de opciones para las respuestas:<\/p>\n\n\n\n Para especificar el dato que se desea obtener de una respuesta, en la barra de URL vac\u00eda por ejemplo, ingresamos \u2018\/response\u2019 y se despliegan las opciones.<\/p>\n\n\n Seleccionamos la deseada, en mi caso seleccion\u00e9 Body Attribute<\/strong>. Luego hacemos click en el tag que est\u00e1 en rojo y configuramos el resto de las opciones.<\/p>\n\n\n En Request <\/strong>debemos especificar a qu\u00e9 pedido hacemos referencia, lo seleccionamos de la lista desplegable. En Filter<\/strong>, que puede ser un JSONPath o XPath, ingresamos el dato que queremos obtener de la respuesta, que se visualizar\u00e1 en el recuadro Live Preview<\/strong>.<\/p>\n\n\n En el siguiente ejemplo en el proyecto de GoRest, usamos el id obtenido de la respuesta del m\u00e9todo POST NewUser para enviar un pedido del tipo GET UserById. El dato lo pasamos como query del pedido:<\/p>\n\n\n Y configuramos el tag de la siguiente manera:<\/p>\n\n\n En el siguiente ejemplo en el proyecto de CountryInfoService, tomamos el ISO Code de la respuesta del pedido CountryByName y se lo pasamos al pedido FullCountryInfoByISOCode de la siguiente manera:<\/p>\n\n\n Como en el caso anterior, seleccionamos la respuesta que contiene el dato y en Filter ingresamos el XPath correspondiente:<\/p>\n\n\n De esta manera podemos ver que es diferente a c\u00f3mo se manejan los datos entre pedidos en Postman por ejemplo, aunque Insomnia tambi\u00e9n permite hacerlo mediante variables de entorno.<\/p>\n\n\n\n A diferencia de Postman o SoapUI, Insomnia ofrece una pesta\u00f1a aparte para las pruebas. Anteriormente est\u00e1bamos trabajando en la pesta\u00f1a DEBUG con las peticiones y respuestas. Las pruebas unitarias se basan en el framework Mocha <\/a>y Chai<\/a> para las assertions, con JavaScript, seg\u00fan la documentaci\u00f3n<\/a>.<\/p>\n\n\n Las pruebas unitarias se pueden organizar en Suites. Se pueden correr individualmente o correr la Suite completa.<\/p>\n\n\n La imagen 1 muestra la organizaci\u00f3n de las pruebas unitarias en Suites en el panel de la izquierda.<\/p>\n\n\n La imagen 2 muestra las pruebas unitarias dentro de la Suite, relacionadas con la petici\u00f3n correspondiente, en el panel central.<\/p>\n\n\n Y la imagen 3 muestra los resultados de las pruebas con el tiempo consumido, en el panel situado a la derecha del workspace.<\/p>\n\n\n\n En el caso del proyecto con SOAP es el mismo procedimiento:<\/p>\n\n\n Inso CLI (interfaz de l\u00ednea de comandos) para Insomnia se basa en Node.js<\/a> y en las librer\u00edas principales de Insomnia. Permite utilizar la funcionalidad de Insomnia en la terminal y entornos de CI\/CD para la automatizaci\u00f3n. En este momento, Inso CLI solo funciona con documentos de dise\u00f1o<\/a> y no con colecciones de solicitudes.<\/p>\n\n\n\n Existen dos formas de instalar Inso CLI:<\/p>\n\n\n\n En mi caso lo instal\u00e9 mediante la primera opci\u00f3n. Luego de instalado prob\u00e9 con los comandos como se explica en la documentaci\u00f3n<\/a>, y este fue el resultado de correr las suites de pruebas del proyecto GoREST:<\/p>\n\n\n Al correr el comando inso run test<\/strong> sin especificar un documento, se nos pide que seleccionemos uno de la lista. Luego de seleccionar el documento o la suite a probar, se nos pide que seleccionemos el ambiente, como se aprecia en la captura.<\/p>\n\n\n\n Lo mismo hice para el proyecto de CountryInfoService:<\/p>\n\n\n Si no se especifica un tipo de reporte<\/a> (dot, list, spec, min y progress), por defecto usa spec.<\/p>\n\n\n\n Este comando extrae y exporta la especificaci\u00f3n OpenAPI<\/a> sin procesar. La especificaci\u00f3n OpenAPI es el est\u00e1ndar para documentar API, y OpenAPI 3.0 es la versi\u00f3n m\u00e1s reciente de la especificaci\u00f3n OpenAPI. OpenAPI 3.0 ofrece diferentes mejoras, como una estructura m\u00e1s sencilla para definir API y componentes m\u00e1s reutilizables para reducir la duplicaci\u00f3n.<\/p>\n\n\n\n Con la opci\u00f3n \u2014 output <path> se guarda la especificaci\u00f3n en un archivo.<\/p>\n\n\n\n Exporta la especificaci\u00f3n cargada en la pesta\u00f1a \u2018DESIGN\u2019.<\/p>\n\n\n\n Un documento de OpenAPI describe la interfaz p\u00fablica de la API REST y define informaci\u00f3n como nombre y descripci\u00f3n, los extremos (rutas) individuales, c\u00f3mo se autentican los emisores. Uno de los beneficios principales del uso de OpenAPI es para la documentaci\u00f3n; una vez que se tiene un documento de OpenAPI que describe la API, es f\u00e1cil generar la documentaci\u00f3n de referencia para la misma.<\/p>\n\n\n\n Este comando genera una configuraci\u00f3n a partir de la especificaci\u00f3n de API declarada en DESIGN mediante openapi-2-kong<\/a>. El comando funciona de manera similar a generar un archivo de configuraci\u00f3n declarativo o <\/a>un manifiesto de Kubernetes<\/a> desde Insomnia. Puede verse un ejemplo aqu\u00ed<\/a>.<\/p>\n\n\n\n Insomnia permite crear un archivo preformateado decK <\/a>cuando se agregan endpoints al documento o puede tomar un documento y generar un manifiesto de Kubernetes.<\/p>\n\n\n\n Ambas opciones est\u00e1n disponibles tambi\u00e9n en la interfaz de usuario de Insomnia.<\/p>\n\n\n\n Inso CLI se ha dise\u00f1ado para ejecutarse en un entorno de integraci\u00f3n continua (CI)<\/strong>, quita la necesidad interactuar con la herramienta mediante prompts y proporciona c\u00f3digos de salida para aprobar o fallar el flujo de trabajo de CI. Puede verse un ejemplo aqu\u00ed<\/a>.<\/p>\n\n\n\n Para trabajar en equipo y poder sincronizar los proyectos, es necesario registrarse en el dashboard web<\/a> de Insomnia. En la documentaci\u00f3n<\/a> se explica c\u00f3mo trabajar en equipo y sincronizar los proyectos.<\/p>\n\n\n Una vez ingresados en el dashboard podemos gestionar el equipo y agregar miembros a trav\u00e9s del correo electr\u00f3nico.<\/p>\n\n\n Una vez sincronizado el trabajo, todos los miembros del equipo pueden visualizar en Insomnia desktop los proyectos del dashboard compartido.<\/p>\n\n\n\n Mi dashboard:<\/p>\n\n\n El dashboard de un colaborador:<\/p>\n\n\n En la siguiente tabla se comparan las distintas versiones de Insomnia, Postman y SoapUI<\/strong>.<\/p>\n\n\n Insomnia presenta una versi\u00f3n de prueba por 14 d\u00edas permitiendo la colaboraci\u00f3n en equipos de hasta 5 integrantes.<\/p>\n\n\n\n En el caso de SoapUI\/ReadyAPI lo que se compra es la licencia para distintos m\u00f3dulos como API Test o API Performance.<\/p>\n\n\n\n Si bien Insomnia presenta una interfaz muy similar a la de Postman, al estar dividida el \u00e1rea de trabajo en 3 \u2018pesta\u00f1as\u2019 donde se tratan distintos temas (DESIGN\/DEBUG\/TEST), la hace una herramienta m\u00e1s organizada para trabajar.<\/p>\n\n\n\n El dashboard que presenta con los distintos proyectos del workspace y otras acciones como crear la documentaci\u00f3n, tambi\u00e9n resultan amigables para el usuario y ayudan a mantener organizados nuestros proyectos.<\/strong><\/p>\n\n\n\n En mi opini\u00f3n, tiene caracter\u00edsticas muy similares a Postman, no as\u00ed con SoapUI. En comparaci\u00f3n con Postman, me pareci\u00f3 una herramienta muy vers\u00e1til a la hora de trabajar con datos y variables<\/strong>. En la secci\u00f3n de pruebas, le faltar\u00eda agregar algunos snippets como ayuda.<\/p>\n\n\n\n Inso CLI permite un acercamiento a la automatizaci\u00f3n de pruebas<\/strong> permitiendo correr las suites, aunque para mi gusto le faltar\u00eda poder correr las colecciones.<\/p>\n\n\n\n Finalmente, la integraci\u00f3n con GitHub me parece un plus a destacar, ya que hoy en d\u00eda es fundamental el trabajo colaborativo en la red.<\/p>\n\n\n\n Si esta herramienta<\/a> para pruebas de API te parece interesante, te invito a usarla y dejar tus comentarios al respecto.<\/p>\n\n\n\n\n\n \u00a1S\u00edguenos en\u00a0LinkedIn<\/a>,\u00a0X<\/a>,\u00a0Facebook<\/a>,\u00a0Instagram<\/a>\u00a0y\u00a0YouTube<\/a>\u00a0para ser parte de nuestra comunidad y acceder a nuevas herramientas de pruebas de API.<\/strong><\/p>\n","protected":false},"excerpt":{"rendered":" Conoce c\u00f3mo funciona Insomnia, herramienta de pruebas de API de uso intuitivo e interfaz amigable, sus principales caracter\u00edsticas, similitudes y diferencias con otras tools como Postman y SoapUI.<\/p>\n","protected":false},"author":38,"featured_media":15647,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[57],"tags":[143,3,92,16],"class_list":["post-15635","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-herramientas-pruebas","tag-api-testing","tag-automatizacion-pruebas","tag-open-source","tag-pruebas-de-software"],"yoast_head":"\n<\/figure><\/div>\n\n\n
Comparativa de herramientas: Insomnia, Postman y SoapUI<\/strong><\/h2>\n\n\n\n
![\"\"](\"https:\/\/miro.medium.com\/v2\/resize:fit:560\/1*7BKUw36XxFZkr1K0OwYHkA.png\")
<\/figure><\/div>\n\n\nPrimer acercamiento a Insomnia<\/h2>\n\n\n\n
Prueba de concepto con GoREST<\/strong><\/h2>\n\n\n\n
<\/figure><\/div>\n\n
<\/figure><\/div>\n\n\n
<\/figure><\/div>\n\n\n
<\/figure><\/div>\n\n\n
<\/figure><\/div>\n\n\n
<\/figure><\/div>\n\n\n
<\/figure><\/div>\n\n\n
<\/figure><\/div>\n\n\n
<\/figure><\/div>\n\n\n
<\/figure><\/div>\n\n
<\/figure><\/div>\n\n\n
<\/figure><\/div>\n\n\n
<\/figure><\/div>\n\n\n
<\/figure><\/div>\n\n\n
<\/figure><\/div>\n\n\n
<\/figure><\/div>\n\n\n
<\/figure><\/div>\n\n\n
<\/figure><\/div>\n\n\n
<\/figure><\/div>\n\n\n
<\/figure><\/div>\n\n\n
Prueba de Concepto con CountryInfoService<\/strong><\/h2>\n\n\n\n
<\/figure><\/div>\n\n
<\/figure><\/div>\n\n\n
<\/figure><\/div>\n\n\n
<\/figure><\/div>\n\n\n
<\/figure><\/div>\n\n\n
<\/figure><\/div>\n\n\n
Encadenamiento de pedidos y respuestas<\/strong><\/h2>\n\n\n\n
\n
<\/figure><\/div>\n\n\n
<\/figure><\/div>\n\n\n
<\/figure><\/div>\n\n\n
<\/figure><\/div>\n\n\n
<\/figure><\/div>\n\n\n
<\/figure><\/div>\n\n\n
<\/figure><\/div>\n\n\n
Testing en Insomnia<\/strong><\/h2>\n\n\n\n
<\/figure><\/div>\n\n\n
<\/figure><\/div>\n\n
<\/figure><\/div>\n\n\n
<\/figure><\/div>\n\n\n
<\/figure><\/div>\n\n\n
<\/figure><\/div>\n\n\n
Inso CLI<\/strong><\/h2>\n\n\n\n
\n
Inso Run Test<\/strong><\/h2>\n\n\n\n
<\/figure><\/div>\n\n\n
<\/figure><\/div>\n\n\n
Inso Export Spec<\/strong><\/h2>\n\n\n\n
Inso Generate Config<\/strong><\/h2>\n\n\n\n
Integraci\u00f3n Continua<\/strong><\/h2>\n\n\n\n
Colaboraci\u00f3n<\/strong><\/h2>\n\n\n\n
<\/figure><\/div>\n\n\n
<\/figure><\/div>\n\n\n
<\/figure><\/div>\n\n\n
<\/figure><\/div>\n\n\n
Pros de la herramienta Insomnia<\/strong><\/h2>\n\n\n\n
\n
<\/figure><\/div>\n\n
<\/figure><\/div>\n\n\n
\n
<\/figure><\/div>\n\n
<\/figure><\/div>\n\n\n
Contras de la herramienta Insomnia<\/strong><\/h2>\n\n\n\n
\n
Pricing<\/strong><\/h2>\n\n\n\n
![\"\"](\"https:\/\/miro.medium.com\/v2\/resize:fit:560\/1*wjRkMwt8ruHCA8rvApDYWw.png\")
Reflexiones finales<\/h3>\n\n\n\n