easy-soap-request
Version:
A small library to make SOAP requests easier
106 lines (85 loc) • 3.6 kB
Markdown
# easy-soap-request
[](https://github.com/circa10a/easy-soap-request/actions)
[](https://www.npmjs.com/package/easy-soap-request)
[](https://npm-stat.com/charts.html?package=easy-soap-request&from=2018-03-29)
[](https://www.buymeacoffee.com/caleblemoine)
[](https://nodei.co/npm/easy-soap-request)
A small library to make SOAP requests easier via Node.js, Deno, and your browser
## Installation
```bash
npm install easy-soap-request
```
## Usage
### Node.js
```js
const soapRequest = require('easy-soap-request');
const fs = require('fs');
// example data
const url = 'https://graphical.weather.gov/xml/SOAP_server/ndfdXMLserver.php';
const sampleHeaders = {
'user-agent': 'sampleTest',
'Content-Type': 'text/xml;charset=UTF-8',
'soapAction': 'https://graphical.weather.gov/xml/DWMLgen/wsdl/ndfdXML.wsdl#LatLonListZipCode',
};
const xml = fs.readFileSync('test/zip-code-envelope.xml', 'utf-8');
// usage of module
(async () => {
const { response } = await soapRequest({ url: url, headers: sampleHeaders, xml: xml, timeout: 1000 }); // Optional timeout parameter(milliseconds)
const { headers, body, statusCode } = response;
console.log(headers);
console.log(body);
console.log(statusCode);
})();
```
### Deno
```js
import soapRequest from 'https://deno.land/x/easy_soap_request/index.d.js';
// example data
const url = 'https://graphical.weather.gov/xml/SOAP_server/ndfdXMLserver.php';
const sampleHeaders = {
'user-agent': 'sampleTest',
'Content-Type': 'text/xml;charset=UTF-8',
'soapAction': 'https://graphical.weather.gov/xml/DWMLgen/wsdl/ndfdXML.wsdl#LatLonListZipCode',
};
// usage of module
(async () => {
const xml = await Deno.readFile('test/zip-code-envelope.xml');
const { response } = await soapRequest({ url: url, headers: sampleHeaders, xml: xml });
const { headers, body, statusCode } = response;
console.log(headers);
console.log(body);
console.log(statusCode);
})();
```
### Browser
> Note: CORS policies apply
```html
<html>
<script src="https://cdn.jsdelivr.net/npm/easy-soap-request/dist/easy-soap-request.js"></script>
<script>
const url = 'https://my-soap-server';
const sampleHeaders = {
'Content-Type': 'text/xml;charset=UTF-8',
SOAPAction: 'https://my-soap-action/something',
};
const xml = `<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header/>
<soapenv:Body>Some Data</soapenv:Body>
</soapenv:Envelope>`;
async function makeRequest() {
const { response } = await soapRequest({ url: url, headers: sampleHeaders, xml: xml, timeout: 1000 });
const { headers, body, statusCode } = response;
console.log(headers);
console.log(body);
console.log(statusCode);
document.body.innerHTML = body;
};
makeRequest();
</script>
<body></body>
</html>
```
## Changelog
[Changelog.md](CHANGELOG.md)
## Tests
* [Example](https://github.com/circa10a/easy-soap-request/tree/master/test)