Exemplo SOAP mais simples

241

Qual é o exemplo SOAP mais simples usando Javascript?

Para ser o mais útil possível, a resposta deve:

  • Seja funcional (em outras palavras, realmente funcione)
  • Envie pelo menos um parâmetro que possa ser definido em outra parte do código
  • Processe pelo menos um valor de resultado que possa ser lido em outra parte do código
  • Trabalhar com as versões mais modernas do navegador
  • Seja o mais claro e o mais curto possível, sem usar uma biblioteca externa
Thomas Bratt
fonte
5
Ser simples e claro pode entrar em conflito com o não uso de uma biblioteca externa. Deseja realmente escrever seu próprio conversor de classe WSDL -> JS?
Mikemaccana 28/01
19
Eu tenho uma pergunta: se eu vi essa pergunta como a primeira pessoa, seria de esperar que ela fosse votada com comentários do tipo "mostre algum código, isso não é 'alugue um codificador'". Nada pessoal, Thomas :) Mas não consigo entender como a comunidade decide o que é bom e o que é ruim.
最白目
4
Ei, não se preocupe. Acho que o objetivo da pergunta é que existem várias maneiras de escrever um cliente SOAP usando JavaScript. Muitos deles são feios, então eu esperava algumas idéias para mantê-lo limpo.
Thomas Bratt
@dan é porque 1. essa pergunta é bastante antiga, ainda havia muitas perguntas fundamentais que, por tradição, têm muitos votos positivos, 2. descreve um problema bastante simples, por isso provavelmente tende a atrair novos usuários que possam votar por o princípio de "ei, eu também quero saber disso!" em vez de "ei, essa pergunta mostra o esforço de pesquisa. é útil e claro!". Como a pergunta não tem isso na minha opinião, eu diminuí a votação. Nada pessoal também: D
phil294
@ThomasBratt Provavelmente continuarei com essa meta, mas esse tipo de pergunta merece uma chance. É a pergunta ideal para uma biblioteca descendente de referência ou base de conhecimento. Mas talvez a resposta aceita também mereça um incentivo para o trabalho extra? Ainda não há nada mais aceito do que o SO; então, onde mais? Até o SO tentou e brincou com a idéia de construir um site de documentação - e falhou. Nada para substituir SO ...
YoYo

Respostas:

201

Este é o cliente SOAP JavaScript mais simples que posso criar.

<html>
<head>
    <title>SOAP JavaScript Client Test</title>
    <script type="text/javascript">
        function soap() {
            var xmlhttp = new XMLHttpRequest();
            xmlhttp.open('POST', 'https://somesoapurl.com/', true);

            // build SOAP request
            var sr =
                '<?xml version="1.0" encoding="utf-8"?>' +
                '<soapenv:Envelope ' + 
                    'xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" ' +
                    'xmlns:api="http://127.0.0.1/Integrics/Enswitch/API" ' +
                    'xmlns:xsd="http://www.w3.org/2001/XMLSchema" ' +
                    'xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">' +
                    '<soapenv:Body>' +
                        '<api:some_api_call soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">' +
                            '<username xsi:type="xsd:string">login_username</username>' +
                            '<password xsi:type="xsd:string">password</password>' +
                        '</api:some_api_call>' +
                    '</soapenv:Body>' +
                '</soapenv:Envelope>';

            xmlhttp.onreadystatechange = function () {
                if (xmlhttp.readyState == 4) {
                    if (xmlhttp.status == 200) {
                        alert(xmlhttp.responseText);
                        // alert('done. use firebug/console to see network response');
                    }
                }
            }
            // Send the POST request
            xmlhttp.setRequestHeader('Content-Type', 'text/xml');
            xmlhttp.send(sr);
            // send request
            // ...
        }
    </script>
</head>
<body>
    <form name="Demo" action="" method="post">
        <div>
            <input type="button" value="Soap" onclick="soap();" />
        </div>
    </form>
</body>
</html> <!-- typo -->
stackoverflow128
fonte
2
Que tal enviar um <soapenv: Header>? Eu tentei construir minhas tags de cabeçalho para a variável sr, no entanto, o servidor recebeu uma soapenv vazio: Header
Boiler Bill
Isso funcionou para mim! (depois de substituir o URL do Serviço SOAP com um real e desligar restrições entre domínios no meu navegador, como sugere @Prestaul)
Niko Bellic
Estou desenvolvendo aplicativos multiplataforma em nativescript para android / ios. Eu quero usar serviços web SOAP. Por favor, me guie para o mesmo. Eu usei o código acima para solicitação SOAP e quero o formato de resposta SOAP, como lidar com a resposta. Por favor, revise minha pergunta - stackoverflow.com/questions/37745840/…
Onkar Nene
Teve que usar isso recentemente para oferecer suporte ao código legado. Deparamos com um problema com o cabeçalho ausente que estava criando uma "incompatibilidade de ContractFilter no EndpointDispatcher". Adicionando xmlhttp.setRequestHeader('SOAPAction', 'http://myurl.com/action');pouco antes de xmlhttp.send(sr)corrigi-lo.
RDRick
80

Existem muitas peculiaridades na maneira como os navegadores lidam com XMLHttpRequest, esse código JS funcionará em todos os navegadores:
https://github.com/ilinsky/xmlhttprequest

Esse código JS converte XML em objetos JavaScript fáceis de usar:
http://www.terracoder.com/index.php/xml-objectifier

O código JS acima pode ser incluído na página para atender a seus requisitos de biblioteca externa.

var symbol = "MSFT"; 
var xmlhttp = new XMLHttpRequest();
xmlhttp.open("POST", "http://www.webservicex.net/stockquote.asmx?op=GetQuote",true);
xmlhttp.onreadystatechange=function() {
 if (xmlhttp.readyState == 4) {
  alert(xmlhttp.responseText);
  // http://www.terracoder.com convert XML to JSON 
  var json = XMLObjectifier.xmlToJSON(xmlhttp.responseXML);
  var result = json.Body[0].GetQuoteResponse[0].GetQuoteResult[0].Text;
  // Result text is escaped XML string, convert string to XML object then convert to JSON object
  json = XMLObjectifier.xmlToJSON(XMLObjectifier.textToXML(result));
  alert(symbol + ' Stock Quote: $' + json.Stock[0].Last[0].Text); 
 }
}
xmlhttp.setRequestHeader("SOAPAction", "http://www.webserviceX.NET/GetQuote");
xmlhttp.setRequestHeader("Content-Type", "text/xml");
var xml = '<?xml version="1.0" encoding="utf-8"?>' +
 '<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" ' +
                'xmlns:xsd="http://www.w3.org/2001/XMLSchema" ' +
                'xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">' + 
   '<soap:Body> ' +
     '<GetQuote xmlns="http://www.webserviceX.NET/"> ' +
       '<symbol>' + symbol + '</symbol> ' +
     '</GetQuote> ' +
   '</soap:Body> ' +
 '</soap:Envelope>';
xmlhttp.send(xml);
// ...Include Google and Terracoder JS code here...

Duas outras opções:

Chris Stuart
fonte
o que devo fazer se quiser passar vários envelopes?
quer
Eu estou usando o código acima, mas xmlhttp.responseText resulta sempre como null.can u me fornecer somelinks para superar o erro
user969275
Link para quando o Google Code é removido: github.com/ilinsky/xmlhttprequest
ToastyMallows
48

Isso não pode ser feito com JavaScript direto, a menos que o serviço da web esteja no mesmo domínio da sua página. Edit: Em 2008 e no IE <10, isso não pode ser feito com javascript direto, a menos que o serviço esteja no mesmo domínio da sua página.

Se o serviço da web estiver em outro domínio [e você precisar oferecer suporte ao IE <10], será necessário usar uma página de proxy em seu próprio domínio que recuperará os resultados e os retornará para você. Se você não precisar do suporte antigo do IE, precisará adicionar o suporte CORS ao seu serviço. Em ambos os casos, você deve usar algo como a lib que timyates sugeriu, porque você não deseja analisar os resultados por conta própria.

Se o serviço da web estiver em seu próprio domínio, não use SOAP. Não há boas razões para fazê-lo. Se o serviço da web estiver em seu próprio domínio, modifique-o para que ele possa retornar o JSON e poupar o trabalho de lidar com todos os aborrecimentos que acompanham o SOAP.

A resposta curta é: não faça solicitações SOAP do javascript. Use um serviço da Web para solicitar dados de outro domínio e, se você fizer isso, analise os resultados no lado do servidor e retorne-os no formato js.

Prestaul
fonte
1
A intenção é que o servidor SOAP também sirva uma página HTML para teste e avaliação simples. O cliente estaria no mesmo domínio. Não usar o SOAP para o front end parece ser a exibição aceita. Algum comentário sobre o porquê? Adicione à nova pergunta: stackoverflow.com/questions/127038
Thomas Bratt
1
Não faz sentido responder lá ... Concordo com o Gizmo nos três pontos. XML é inchado e um desafio para lidar com js enquanto JSON é conciso e nativo.
Prestaul 24/09/08
10
re "não pode ser feito": hoje isso pode ser feito com JavaScript (principalmente) direto, se o cliente oferecer suporte ao compartilhamento de recursos entre origens . Esperamos que em 3-4 anos ele esteja universalmente disponível.
Constantin
2
@Constantin, o CORS permitirá isso se você estiver disposto a oferecer suporte apenas a navegadores mais recentes e se tiver o controle do servidor e puder adicionar suporte ao CORS também. Dito isto, eu ainda argumentaria que as chamadas SOAP devem ser feitas apenas entre servidores e o cliente deve usar algo mais amigável ao JS, como o JSON.
Prestaul
1
@NikoBellic que um cliente baseado em navegador pode usar XMLHttpRequest, provavelmente por meio de uma biblioteca como o jquery. Um cliente do nó usaria outra coisa. A maioria dos serviços da Web usa o REST como um guia para projetar suas APIs, mas há muitos bons padrões. A chave aqui é que os corpos de solicitação / resposta são JSON porque os clientes javascript (navegador / nó / qualquer outro local) entendem JSON nativamente.
Prestaul
14

Você pode usar o plugin jquery.soap para fazer o trabalho por você.

Este script usa $ .ajax para enviar um SOAPEnvelope. Pode levar XML DOM, string XML ou JSON como entrada e a resposta pode ser retornada como XML DOM, string XML ou JSON também.

Exemplo de uso do site:

$.soap({
    url: 'http://my.server.com/soapservices/',
    method: 'helloWorld',

    data: {
        name: 'Remy Blom',
        msg: 'Hi!'
    },

    success: function (soapResponse) {
        // do stuff with soapResponse
        // if you want to have the response as JSON use soapResponse.toJSON();
        // or soapResponse.toString() to get XML string
        // or soapResponse.toXML() to get XML DOM
    },
    error: function (SOAPResponse) {
        // show error
    }
});
Yaakov Ellis
fonte
8

Thomas:

O JSON é preferido para uso de front-end porque é javascript. Portanto, você não tem XML para lidar. SOAP é uma dor sem usar uma biblioteca por causa disso. Alguém mencionou o SOAPClient, que é uma boa biblioteca, começamos com ela no nosso projeto. No entanto, tinha algumas limitações e tivemos que reescrever grandes partes dele. Ele foi lançado como SOAPjs e oferece suporte à passagem de objetos complexos para o servidor e inclui alguns códigos de proxy de amostra para consumir serviços de outros domínios.

Richard June
fonte
2
"O JSON é preferido para uso front end porque é javascript." - JSON não é JavaScript. (Ele apenas se parece com JavaScript.)
nnnnnn
2
pt.wikipedia.org/wiki/JSON - Literalmente significa "JavaScript Object Notation", e embora eu concorde que o JSON é uma especificação, não uma linguagem e, portanto, decididamente "não é um javascript", você deve concordar que o nome pode facilmente confundir as pessoas.
P. Roe
8

alguem ja tentou isso? https://github.com/doedje/jquery.soap

Parece muito fácil de implementar.

Exemplo:

$.soap({
url: 'http://my.server.com/soapservices/',
method: 'helloWorld',

data: {
    name: 'Remy Blom',
    msg: 'Hi!'
},

success: function (soapResponse) {
    // do stuff with soapResponse
    // if you want to have the response as JSON use soapResponse.toJSON();
    // or soapResponse.toString() to get XML string
    // or soapResponse.toXML() to get XML DOM
},
error: function (SOAPResponse) {
    // show error
}
});

vai resultar em

<soap:Envelope
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <helloWorld>
        <name>Remy Blom</name>
        <msg>Hi!</msg>
    </helloWorld>
  </soap:Body>
</soap:Envelope>
geekasso
fonte
4
<html>
 <head>
    <title>Calling Web Service from jQuery</title>
    <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4.3/jquery.min.js"></script>
    <script type="text/javascript">
        $(document).ready(function () {
            $("#btnCallWebService").click(function (event) {
                var wsUrl = "http://abc.com/services/soap/server1.php";
                var soapRequest ='<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">   <soap:Body> <getQuote xmlns:impl="http://abc.com/services/soap/server1.php">  <symbol>' + $("#txtName").val() + '</symbol>   </getQuote> </soap:Body></soap:Envelope>';
                               alert(soapRequest)
                $.ajax({
                    type: "POST",
                    url: wsUrl,
                    contentType: "text/xml",
                    dataType: "xml",
                    data: soapRequest,
                    success: processSuccess,
                    error: processError
                });

            });
        });

        function processSuccess(data, status, req) { alert('success');
            if (status == "success")
                $("#response").text($(req.responseXML).find("Result").text());

                alert(req.responseXML);
        }

        function processError(data, status, req) {
        alert('err'+data.state);
            //alert(req.responseText + " " + status);
        } 

    </script>
</head>
<body>
    <h3>
        Calling Web Services with jQuery/AJAX
    </h3>
    Enter your name:
    <input id="txtName" type="text" />
    <input id="btnCallWebService" value="Call web service" type="button" />
    <div id="response" ></div>
</body>
</html>

Hear é o melhor JavaScript com tutorial SOAP com exemplo.

http://www.codeproject.com/Articles/12816/JavaScript-SOAP-Client

Hkachhia
fonte
3

Alguns ótimos exemplos (e um cliente SOAP JavaScript pronto!) Aqui: http://plugins.jquery.com/soap/

Verifique o leia-me e tome cuidado com a restrição de navegador da mesma origem.

kmiklas
fonte
3

Consuma facilmente serviços da Web SOAP com JavaScript -> Listagem B

function fncAddTwoIntegers(a, b)
{
    varoXmlHttp = new XMLHttpRequest();
    oXmlHttp.open("POST",
 "http://localhost/Develop.NET/Home.Develop.WebServices/SimpleService.asmx'",
 false);
    oXmlHttp.setRequestHeader("Content-Type", "text/xml");
    oXmlHttp.setRequestHeader("SOAPAction", "http://tempuri.org/AddTwoIntegers");
    oXmlHttp.send(" \
<soap:Envelope xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' \
xmlns:xsd='http://www.w3.org/2001/XMLSchema' \
 xmlns:soap='http://schemas.xmlsoap.org/soap/envelope/'> \
  <soap:Body> \
    <AddTwoIntegers xmlns='http://tempuri.org/'> \
      <IntegerOne>" + a + "</IntegerOne> \
      <IntegerTwo>" + b + "</IntegerTwo> \
    </AddTwoIntegers> \
  </soap:Body> \
</soap:Envelope> \
");
    return oXmlHttp.responseXML.selectSingleNode("//AddTwoIntegersResult").text;
}

Isso pode não atender a todos os seus requisitos, mas é um começo para responder a sua pergunta. ( Troquei XMLHttpRequest () por ActiveXObject ("MSXML2.XMLHTTP") ).

user423430
fonte
1

O exemplo mais simples consistiria em:

  1. Obtendo a entrada do usuário.
  2. Redigindo mensagem SOAP XML semelhante a esta

    <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                   xmlns:xsd="http://www.w3.org/2001/XMLSchema"
                   xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
      <soap:Body>
        <GetInfoByZIP xmlns="http://www.webserviceX.NET">
          <USZip>string</USZip>
        </GetInfoByZIP>
      </soap:Body>
    </soap:Envelope>
  3. POSTando a mensagem no URL do serviço da web usando XHR

  4. Analisando a resposta XML SOAP do serviço da web semelhante a esta

    <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
                   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                   xmlns:xsd="http://www.w3.org/2001/XMLSchema">
     <soap:Body>
      <GetInfoByZIPResponse xmlns="http://www.webserviceX.NET">
       <GetInfoByZIPResult>
        <NewDataSet xmlns="">
         <Table>
          <CITY>...</CITY>
          <STATE>...</STATE>
          <ZIP>...</ZIP>
          <AREA_CODE>...</AREA_CODE>
          <TIME_ZONE>...</TIME_ZONE>
         </Table>
        </NewDataSet>
       </GetInfoByZIPResult>
      </GetInfoByZIPResponse>
     </soap:Body>
    </soap:Envelope>
  5. Apresentando resultados ao usuário.

Mas é muito trabalhoso sem bibliotecas JavaScript externas.

Constantin
fonte
9
Não é um exemplo de Javacript.
Thomas Bratt
Nem mesmo a primeira parte que você não respondeu - Seja funcional (em outras palavras, realmente funcione).
Shahar Eldad
0
function SoapQuery(){
  var namespace = "http://tempuri.org/";
  var site = "http://server.com/Service.asmx";
  var xmlhttp = new ActiveXObject("Msxml2.ServerXMLHTTP.6.0");
  xmlhttp.setOption(2,  13056 );  /* if use standard proxy */
  var args,fname =  arguments.callee.caller.toString().match(/ ([^\(]+)/)[1]; /*Имя вызвавшей ф-ции*/
  try { args =   arguments.callee.caller.arguments.callee.toString().match(/\(([^\)]+)/)[1].split(",");  
    } catch (e) { args = Array();};
  xmlhttp.open('POST',site,true);  
  var i, ret = "", q = '<?xml version="1.0" encoding="utf-8"?>'+
   '<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">'+
   '<soap:Body><'+fname+ ' xmlns="'+namespace+'">';
  for (i=0;i<args.length;i++) q += "<" + args[i] + ">" + arguments.callee.caller.arguments[i] +  "</" + args[i] + ">";
  q +=   '</'+fname+'></soap:Body></soap:Envelope>';
            // Send the POST request
            xmlhttp.setRequestHeader("MessageType","CALL");
            xmlhttp.setRequestHeader("SOAPAction",namespace + fname);
            xmlhttp.setRequestHeader('Content-Type', 'text/xml');
            //WScript.Echo("Запрос XML:" + q);
            xmlhttp.send(q);
     if  (xmlhttp.waitForResponse(5000)) ret = xmlhttp.responseText;
    return ret;
  };





function GetForm(prefix,post_vars){return SoapQuery();};
function SendOrder2(guid,order,fio,phone,mail){return SoapQuery();};

function SendOrder(guid,post_vars){return SoapQuery();};
usuario
fonte
0

Angularjs $ http wrap base em XMLHttpRequest . Contanto que no conteúdo do cabeçalho definido o seguinte código funcione.

"Content-Type": "text/xml; charset=utf-8"

Por exemplo:

function callSoap(){
var url = "http://www.webservicex.com/stockquote.asmx";
var soapXml = "<soapenv:Envelope xmlns:soapenv=\"http://schemas.xmlsoap.org/soap/envelope/\" xmlns:web=\"http://www.webserviceX.NET/\"> "+
         "<soapenv:Header/> "+
         "<soapenv:Body> "+
         "<web:GetQuote> "+
         "<web:symbol></web:symbol> "+
         "</web:GetQuote> "+
         "</soapenv:Body> "+
         "</soapenv:Envelope> ";

    return $http({
          url: url,  
          method: "POST",  
          data: soapXml,  
          headers: {  
              "Content-Type": "text/xml; charset=utf-8"
          }  
      })
      .then(callSoapComplete)
      .catch(function(message){
         return message;
      });

    function callSoapComplete(data, status, headers, config) {
        // Convert to JSON Ojbect from xml
        // var x2js = new X2JS();
        // var str2json = x2js.xml_str2json(data.data);
        // return str2json;
        return data.data;

    }

}
ChokYeeFan
fonte
0

A pergunta é 'Qual é o exemplo SOAP mais simples usando Javascript?'

Esta resposta é um exemplo no ambiente Node.js. , em vez de um navegador. (Vamos nomear o script soap-node.js) E usaremos o serviço da web SOAP público da Europa PMC como um exemplo para obter a lista de referência de um artigo.

const XMLHttpRequest = require("xmlhttprequest").XMLHttpRequest;
const DOMParser = require('xmldom').DOMParser;

function parseXml(text) {
    let parser = new DOMParser();
    let xmlDoc = parser.parseFromString(text, "text/xml");
    Array.from(xmlDoc.getElementsByTagName("reference")).forEach(function (item) {
        console.log('Title: ', item.childNodes[3].childNodes[0].nodeValue);
    });

}

function soapRequest(url, payload) {
    let xmlhttp = new XMLHttpRequest();
    xmlhttp.open('POST', url, true);

    // build SOAP request
    xmlhttp.onreadystatechange = function () {
        if (xmlhttp.readyState == 4) {
            if (xmlhttp.status == 200) {
                parseXml(xmlhttp.responseText);
            }
        }
    }

    // Send the POST request
    xmlhttp.setRequestHeader('Content-Type', 'text/xml');
    xmlhttp.send(payload);
}

soapRequest('https://www.ebi.ac.uk/europepmc/webservices/soap', 
    `<?xml version="1.0" encoding="UTF-8"?>
    <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Header />
    <S:Body>
        <ns4:getReferences xmlns:ns4="http://webservice.cdb.ebi.ac.uk/"
            xmlns:ns2="http://www.scholix.org"
            xmlns:ns3="https://www.europepmc.org/data">
            <id>C7886</id>
            <source>CTX</source>
            <offSet>0</offSet>
            <pageSize>25</pageSize>
            <email>ukpmc-phase3-wp2b---do-not-reply@europepmc.org</email>
        </ns4:getReferences>
    </S:Body>
    </S:Envelope>`);

Antes de executar o código, você precisa instalar dois pacotes:

npm install xmlhttprequest
npm install xmldom

Agora você pode executar o código:

node soap-node.js

E você verá a saída como abaixo:

Title:  Perspective: Sustaining the big-data ecosystem.
Title:  Making proteomics data accessible and reusable: current state of proteomics databases and repositories.
Title:  ProteomeXchange provides globally coordinated proteomics data submission and dissemination.
Title:  Toward effective software solutions for big biology.
Title:  The NIH Big Data to Knowledge (BD2K) initiative.
Title:  Database resources of the National Center for Biotechnology Information.
Title:  Europe PMC: a full-text literature database for the life sciences and platform for innovation.
Title:  Bio-ontologies-fast and furious.
Title:  BioPortal: ontologies and integrated data resources at the click of a mouse.
Title:  PubMed related articles: a probabilistic topic-based model for content similarity.
Title:  High-Impact Articles-Citations, Downloads, and Altmetric Score.
Yuci
fonte