[Tutorial] Testando APIs SOAP usando Axios

"SOAP Axios" pode ser uma frase que você já leu ou ouviu antes ao falar sobre desenvolvimento web. No entanto, a frase compreende dois conceitos importantes que você deve conhecer.

Quando colocados juntos, "SOAP Axios" é considerado como desenvolvedores usando Axios para depurar uma API SOAP.

SOAP - Protocolo de Acesso a Objetos Simples

SOAP, também conhecido como Protocolo de Acesso a Objetos Simples, é um protocolo que define as regras para estruturar mensagens no desenvolvimento web. Ele garante a troca de informações estruturadas em serviços e sistemas web na mesma rede.

Com o protocolo SOAP, é possível que programas e aplicações que funcionam em diferentes sistemas operacionais se comuniquem. Confira APIs SOAP populares para entender mais sobre o que elas fazem.

Características Significativas que Definem o SOAP

Protocolo Padronizado: SOAP é um protocolo padronizado mantido pelo World Wide Web Consortium (W3C). Essa padronização garante consistência e interoperabilidade entre diferentes sistemas e plataformas.

Mensagens Baseadas em XML: As mensagens SOAP são formatadas usando XML (Extensible Markup Language), permitindo que sejam facilmente lidas por humanos e máquinas. O XML também fornece uma estrutura bem definida para solicitações e respostas.

Especificação Rigorosa: SOAP possui uma especificação rigorosa e bem definida para a estrutura da mensagem que inclui cabeçalhos e corpo. Isso pode ser uma vantagem em cenários onde altos níveis de consistência e formalidade são exigidos.

Tratamento de Erros Integrado: SOAP possui tratamento de erros integrado por meio de elementos de falha padronizados, tornando a comunicação de erros detalhados mais fácil.

Independência de Protocolo: As mensagens SOAP podem ser transportadas por vários protocolos de transporte, incluindo HTTP, SMTP e mais. Essa flexibilidade permite que o SOAP seja usado em uma ampla gama de ambientes de rede.

Documentação de Arquivo WSDL: WSDL, uma linguagem baseada em XML, geralmente vem com uma API SOAP para ajudar a descrevê-la. Ela descreve as funcionalidades, parâmetros e outros detalhes fornecidos pelo serviço web, ajudando os usuários ou clientes do serviço a entender e interagir com ele.

O que é Axios?

Axios é uma biblioteca JavaScript popular usada para fazer requisições HTTP a partir de um navegador web ou ambiente Node.js. Axios foi criado para ser fácil, suportando a API Promise. Isso torna o Axios a escolha dos desenvolvedores para lidar com operações assíncronas ao trabalhar com APIs.

Características Definidoras do Axios

Com base em Promises: Axios é construído em cima de Promises. Simplificando o manejo de código assíncrono, permite que desenvolvedores se concentrem em uma sintaxe mais limpa e legível, facilitando o gerenciamento de respostas e erros.

Suporte a Navegadores e Node.js: Axios é aplicável em navegadores web e ambientes Node.js, tornando-se uma escolha versátil para desenvolvedores que estão trabalhando em aplicações full-stack.

Intercepção de Requisições e Respostas: Axios permite que desenvolvedores interceptem e modifiquem requisições ou respostas antes que sejam tratadas. Este recurso é particularmente útil para tarefas como adicionar cabeçalhos às requisições ou tratar tokens de autenticação.

Transformação Automática de Dados JSON: Axios automaticamente analisa respostas JSON, simplificando o processo de trabalho com dados JSON de APIs.

Controle de Concorrência: Axios fornece recursos como cancelamento de requisições, que pode ser útil em cenários onde um usuário navega para fora de uma página ou cancela uma ação, evitando requisições de rede desnecessárias.

Exemplo de Requisição GET Simples do Axios

Se você está se perguntando como pode ser uma requisição HTTP Axios, aqui está uma requisição GET simples.

import axios from 'axios';

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

Vantagens de Usar Axios para Depurar APIs SOAP

Inspeção de Requisição HTTP: Axios permite que você inspecione os detalhes da requisição HTTP sendo enviada para a API SOAP. Os detalhes da requisição incluem cabeçalhos, payload da requisição e quaisquer outras opções de configuração. Permitir que os desenvolvedores vejam esses detalhes é crucial para identificar problemas na estrutura da requisição ou nos cabeçalhos.

Tratamento de Respostas: As respostas da API SOAP recebidas após o envio de uma requisição são muito fáceis de ler e entender devido à linguagem de programação legível. Axios também fornece acesso a dados de resposta, cabeçalhos e códigos de status. Isso ajuda a entender a resposta do servidor e identificar problemas potenciais.

Tratamento de Erros: Axios permite que você trate erros que podem ocorrer durante a requisição HTTP. Isso é valioso para depurar chamadas à API SOAP, pois permite capturar e registrar erros, oferecendo insights sobre o que deu errado durante a comunicação.

Intercepção de Requisição e Resposta: Axios suporta a intercepção de requisições e respostas, permitindo que você modifique a requisição ou resposta antes que sejam enviadas ou processadas. Isso pode ser útil para adicionar cabeçalhos personalizados, registrar ou fazer ajustes durante a depuração.

Usando Axios para Depurar APIs SOAP

Apidog é uma plataforma de API que apoia desenvolvedores web com uma miríade de funções, desde o design até o teste de APIs.

Vamos conferir como você pode usar Axios com Apidog para depurar uma API SOAP. Mas antes de começar esse processo, certifique-se de instalar o Axios no Bash executando uma das linhas de código abaixo

npm install axios
# ou
yarn add axios

Crie um Script Node.js e Execute-o

Se você ainda não criou um arquivo de script Node.js, pode se referir ao exemplo abaixo, chamado debug-soap-api.js. Certifique-se de alterar os detalhes conforme necessário para a sua API SOAP.

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

// Definir o endpoint SOAP e o payload da requisição
const soapEndpoint = 'https://example.com/soap-endpoint';
const soapRequest = `
  <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"...>
    <!-- Sua requisição SOAP aqui -->
  </soapenv:Envelope>
`;

// Fazer uma requisição POST usando Axios
axios.post(soapEndpoint, soapRequest, {
  headers: { 'Content-Type': 'text/xml' }
})
.then(response => {
  // Tratar a resposta da API SOAP
  console.log('Resposta SOAP:', response.data);
})
.catch(error => {
  // Tratar erros durante a requisição à API SOAP
  console.error('Erro SOAP:', error);
});

Uma vez que você tenha terminado de configurar seu Script Node.js, execute esta linha de código no Bash. Certifique-se de substituir o nome de debug-soap-api.js pelo nome real do seu script Node.js.

node debug-soap-api.js

Inspecione e Copie a Saída

Se a etapa acima foi executada corretamente, você deve ser capaz de ver uma saída no console do seu computador. Essa saída inclui respostas da API SOAP, com quaisquer erros que possam ter ocorrido durante a requisição.

Se você acredita que essa saída corresponde às suas expectativas, então sua API SOAP está funcionando corretamente.

Usando Apidog como Alternativa ao Axios para Testes SOAP

Usando Apidog, você tem a capacidade de testar qualquer solicitação de serviço web. Para isso, dê uma olhada nos passos abaixo.

test soap api request wsdl file apidog — Testando a(s) solicitação(ões) de uma API SOAP

Seta 1 - Selecione a requisição específica que precisa ser selecionada. Neste exemplo, a requisição selecionada é chamada Success.

Seta 2 - Clique no botão "Enviar" uma vez que a URL da requisição tenha sido especificada.

Seta 3 - Observe a resposta recebida após o envio da requisição.

Usando Apidog para Gerar o Código do Cliente Axios

Você pode replicar a Requisição HTTP do Axios para a API SOAP usando o recurso de geração de código do Apidog.

Siga os passos abaixo para aprender a utilizá-lo!

button generate axios client code apidog — Botão para Gerar Código do Cliente

Primeiro, inicie uma nova requisição e localize o botão </> que está no canto superior direito da tela. Se você tiver dificuldade em encontrá-lo, consulte a imagem, onde está indicado pela seta acima.

Uma vez que você o localize, pressione-o e selecione "Gerar Código do Cliente".

generate axios javascript code apidog — Gerando Exemplo de Código Axios Usando Apidog

Você deve agora ter uma janela pop-up com o título "Gerar Código". Aqui, você pode selecionar "JavaScript" e escolher "Axios", como mostrado na imagem acima.

Agora, você pode copiar o código para sua área de transferência e colá-lo no Axios como uma estrutura base para começar a criar a requisição HTTP Axios para depurar sua API SOAP!

Criando Documentação Para Requisições no Apidog

Apidog também permite que os usuários criem documentação de API para sua API SOAP de forma simples.

step by step process sharing api documentation apidog — A Documentação REST API é Compartilhável no Apidog

Primeiro, encontre o botão "Compartilhar" como apontado pela Seta 1, e pressione o botão "+ Novo" como indicado pela Seta 2

input api details and select api doc properties apidog — Insira e Selecione as Propriedades da Documentação da API com Apidog

Apidog oferece a opção de escolher quem pode visualizar sua documentação de API, bem como definir uma senha de arquivo, para que apenas indivíduos ou organizações escolhidas possam visualizá-la.

Uma vez que todos os campos obrigatórios, como nome e idioma da documentação de API, tenham sido preenchidos, pressione Enter em seu teclado ou o botão Salvar.

Visualizar ou Compartilhar Sua Documentação de API REST

open share edit api documentation apidog — Documentação da API Pronta para Visualização

Apidog compila os detalhes do seu projeto de API em uma documentação de API que pode ser visualizada através de uma URL de site. Tudo que você precisa fazer é clicar no link "Copiar Link" sob "Ações" e inserir a URL em seu navegador favorito para visualizar sua Documentação de API!

Se você estiver interessado, leia este artigo sobre como gerar documentação de API usando Apidog.

Conclusão

Embora o Axios forneça essas vantagens para depuração, é importante notar que depurar APIs SOAP pode também envolver o entendimento do protocolo SOAP, da estrutura XML e dos requisitos específicos do serviço SOAP. Além disso, ferramentas dedicadas de teste de API como Apidog podem oferecer um suporte mais especializado para trabalhar com recursos específicos de SOAP.