[Tutorial] Probar APIs SOAP usando Axios

"SOAP Axios" podría ser una frase que hayas leído o escuchado antes al hablar sobre desarrollo web. No obstante, la frase comprende dos conceptos importantes que debes conocer.

Cuando se juntan, "SOAP Axios" se considera como desarrolladores que usan Axios para depurar una API SOAP.

SOAP - Protocolo Simple de Acceso a Objetos

SOAP, también conocido como Protocolo Simple de Acceso a Objetos, es un protocolo que define las reglas para estructurar mensajes en el desarrollo web. Asegura el intercambio de información estructurada en servicios web y sistemas en la misma red.

Con el protocolo SOAP, es posible que programas y aplicaciones que se ejecutan en diferentes sistemas operativos se comuniquen entre sí. Consulta APIs SOAP populares para comprender mejor lo que hacen.

Características Significativas que Definen SOAP

Protocolo Estandarizado: SOAP es un protocolo estandarizado mantenido por el Consorcio World Wide Web (W3C). Esta estandarización asegura la consistencia e interoperabilidad entre diferentes sistemas y plataformas.

Mensajería Basada en XML: Los mensajes SOAP se formatean utilizando XML (Lenguaje de Marcado Extensible), lo que permite que sean fácilmente leídos por humanos y máquinas. XML también proporciona una estructura bien definida para solicitudes y respuestas.

Especificación Estricta: SOAP tiene una especificación estricta y bien definida para la estructura de los mensajes que incluye encabezados y cuerpo. Esto puede ser una ventaja en escenarios donde se requieren altos niveles de consistencia y formalidad.

Manejo de Errores Incorporado: SOAP tiene manejo de errores incorporado a través de elementos de fallo estandarizados, lo que facilita la generación de informes de errores detallados.

Independencia del Protocolo: Los mensajes SOAP pueden ser transportados a través de varios protocolos de transporte, incluyendo HTTP, SMTP y más. Esta flexibilidad permite que SOAP se utilice en una amplia gama de entornos de red.

Documentación de Archivos WSDL: WSDL, un lenguaje basado en XML, generalmente viene con una API SOAP para ayudar a describirla. Describe las funcionalidades, los parámetros y otros detalles proporcionados por el servicio web, ayudando a los usuarios o clientes del servicio web a comprender e interactuar con el servicio.

¿Qué es Axios?

Axios es una biblioteca popular de JavaScript utilizada para realizar solicitudes HTTP desde un navegador web o un entorno Node.js. Axios se hizo para ser fácil, soportando la API Promise. Esto convierte a Axios en la elección de un desarrollador para manejar operaciones asíncronas cuando se trabaja con APIs.

Características Definitorias de Axios

Basado en Promesas: Axios está construido sobre Promesas. Simplificando el manejo de código asíncrono permite a los desarrolladores centrarse en una sintaxis más limpia y legible, facilitando la gestión de respuestas y errores.

Soporte para Navegador y Node.js: Axios es aplicable en navegadores web y entornos Node.js, lo que lo convierte en una opción versátil para los desarrolladores que trabajan en aplicaciones de pila completa.

Interceptación de Solicitudes y Respuestas: Axios permite a los desarrolladores interceptar y modificar solicitudes o respuestas antes de que sean manejadas. Esta característica es particularmente útil para tareas como agregar encabezados a las solicitudes o manejar tokens de autenticación.

Transformación Automática de Datos JSON: Axios analiza automáticamente las respuestas JSON, simplificando el proceso de trabajar con datos JSON de las APIs.

Control de Concurrencia: Axios proporciona características como la cancelación de solicitudes, lo que puede ser útil en escenarios donde un usuario navega fuera de una página o cancela una acción, evitando solicitudes de red innecesarias.

Ejemplo de Solicitud HTTP Get Simple de Axios

Si te preguntas cómo podría ser una solicitud HTTP de Axios, aquí tienes una solicitud GET simple.

import axios from 'axios';

axios.get('https://api.example.com/data')
  .then(response => {
    console.log(response.data);
  })
  .catch(error => {
    console.error('Error fetching data:', error);
  });

Ventajas de Usar Axios para Depurar APIs SOAP

Inspección de Solicitudes HTTP: Axios te permite inspeccionar los detalles de la solicitud HTTP que se envía a la API SOAP. Los detalles de la solicitud incluyen encabezados, carga útil de la solicitud y cualquier otra opción de configuración. Permitir a los desarrolladores ver estos detalles es crucial para identificar problemas en la estructura de la solicitud o los encabezados.

Manejo de Respuestas: Las respuestas de la API SOAP recibidas después de enviar una solicitud son muy fáciles de leer y comprender debido al lenguaje de programación legible. Axios también proporciona acceso a los datos de la respuesta, los encabezados y los códigos de estado. Esto ayuda a comprender la respuesta del servidor e identificar posibles problemas.

Manejo de Errores: Axios te permite manejar los errores que puedan ocurrir durante la solicitud HTTP. Esto es valioso para depurar llamadas a la API SOAP, ya que te permite capturar y registrar errores, proporcionando información sobre lo que salió mal durante la comunicación.

Interceptación de Solicitudes y Respuestas: Axios soporta la interceptación de solicitudes y respuestas, permitiéndote modificar la solicitud o respuesta antes de que sea enviada o procesada. Esto puede ser útil para agregar encabezados personalizados, registrar o hacer ajustes durante la depuración.

Usando Axios para Depurar APIs SOAP

Apidog es una plataforma API que apoya a los desarrolladores web con una miríada de funciones, desde el diseño hasta la prueba de APIs.

Veamos cómo puedes usar Axios con Apidog para depurar una API SOAP. Pero antes de comenzar este proceso, asegúrate de instalar Axios en Bash ejecutando cualquiera de las siguientes líneas de código

npm install axios
# or
yarn add axios

Crea un Script de Node.js y Ejecútalo

Si no has creado un archivo de script de Node.js, puedes consultar el ejemplo a continuación, llamado debug-soap-api.js. Asegúrate de cambiar los detalles de acuerdo con lo que requiera tu API SOAP.

// Import Axios
const axios = require('axios');

// Define SOAP endpoint and request payload
const soapEndpoint = 'https://example.com/soap-endpoint';
const soapRequest = `
  <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"...>
    <!-- Your SOAP request here -->
  </soapenv:Envelope>
`;

// Make a POST request using Axios
axios.post(soapEndpoint, soapRequest, {
  headers: { 'Content-Type': 'text/xml' }
})
.then(response => {
  // Handle the SOAP API response
  console.log('SOAP Response:', response.data);
})
.catch(error => {
  // Handle errors during the SOAP API request
  console.error('SOAP Error:', error);
});

Una vez que hayas terminado de configurar tu Script de Node.js, ejecuta esta línea de código en Bash. Asegúrate de reemplazar el nombre de debug-soap-api.js de acuerdo con el nombre real del archivo de tu script de Node.js.

node debug-soap-api.js

Inspecciona y Copia la Salida

Si el paso anterior se ha ejecutado correctamente, deberías poder ver una salida en la consola de tu ordenador. Dicha salida incluye respuestas de la API SOAP, con cualquier error que pueda haber ocurrido durante la solicitud.

Si crees que esta salida coincide con tus expectativas, entonces tu API SOAP está funcionando correctamente.

Usando Apidog como Alternativa a Axios para Pruebas SOAP

Con el uso de Apidog, tienes la capacidad de probar cualquier solicitud de servicio web. Para ello, echa un vistazo a los siguientes pasos.

test soap api request wsdl file apidog — Probando la(s) solicitud(es) de una API SOAP

Flecha 1 - Selecciona la solicitud específica que necesita ser seleccionada. En este ejemplo, la solicitud seleccionada se llama Success.

Flecha 2 - Haz clic en el botón "Send" una vez que se haya especificado la URL de la solicitud.

Flecha 3 - Observa la respuesta recibida después de que se haya enviado la solicitud.

Usando Apidog para Generar el Código Cliente de Axios

Puedes replicar la Solicitud HTTP de Axios para la API SOAP utilizando la función de generación de código de Apidog.

¡Sigue los pasos a continuación para aprender cómo utilizarla!

button generate axios client code apidog — Botón para Generar Código Cliente

En primer lugar, inicia una nueva solicitud y localiza el botón </> que se encuentra en la esquina superior derecha de la pantalla. Si tienes problemas para encontrarlo, consulta la imagen, donde se señala con la flecha de arriba.

Una vez que lo hayas localizado, presiónalo y selecciona "Generate Client Code".

generate axios javascript code apidog — Generando Código de Muestra de Axios Usando Apidog

Ahora deberías tener una ventana emergente con el título "Generate Code". Aquí, puedes seleccionar "JavaScript" y seleccionar "Axios" como se muestra en la imagen de arriba.

Ahora, puedes copiar el código a tu portapapeles y pegarlo en Axios como una estructura esqueleto para comenzar a crear la solicitud HTTP de Axios para depurar tu API SOAP.

Creando Documentación Para Solicitudes en Apidog

Apidog también permite a los usuarios crear sin problemas documentación API para tu API SOAP.

step by step process sharing api documentation apidog — La Documentación de la API REST es Compartible en Apidog

Primero, encuentra el botón "Share" como se indica con la Flecha 1, y presiona el botón "+ New" como se indica con la Flecha 2

input api details and select api doc properties apidog — Ingresa y Selecciona las Propiedades de la Documentación de la API con Apidog

Apidog proporciona la opción de elegir quién puede ver tu documentación API, así como establecer una contraseña de archivo, para que solo las personas u organizaciones elegidas puedan verla.

Una vez que se hayan completado todos los campos requeridos, como el nombre de la documentación API y el idioma, presiona Enter en tu teclado o el botón Save.

Visualiza o Comparte Tu Documentación de la API REST

open share edit api documentation apidog — Documentación de la API Lista para Ser Visualizada

Apidog compila los detalles del proyecto de tu API en una documentación API que se puede ver a través de una URL de sitio web. Todo lo que tienes que hacer es hacer clic en el enlace "Copy Link" debajo de "Actions", e ingresar la URL en tu navegador favorito para ver tu Documentación API.

Si estás interesado, lee este artículo sobre cómo generar documentación API usando Apidog.

Conclusión

Si bien Axios proporciona estas ventajas para la depuración, es importante tener en cuenta que la depuración de APIs SOAP también puede implicar la comprensión del protocolo SOAP, la estructura XML y los requisitos específicos del servicio SOAP. Además, las herramientas de prueba de API dedicadas, como Apidog, pueden ofrecer un soporte más especializado para trabajar con características específicas de SOAP.