Example of using the LoopBack SOAP connector.
Page Contents

loopback-example-connector (SOAP)

The SOAP connector enables LoopBack applications to interact with SOAP-based web services described using WSDL. This example app illustrates calling a periodic table SOAP web service from a LoopBack app, where you define a remote method to call each SOAP web service operation. This is a simple example of a LoopBack app “proxying” or intermediating a web service.

For more information, see the SOAP connector documentation.


Clone this repo and install dependencies from npm:

$ git clone https://github.com/strongloop-community/loopback-example-connector.git -b soap
$ cd loopback-example-connector
$ npm install

Run the example

  1. In the project root directory, run the app by entering this command:
     node .

    You’ll see this in the console:

     Web server listening at:
     Browse your REST API at
  2. Open API Explorer in your web browser.
  3. Under the periodicTable model, you’ll see two endpoints: GET /periodicTables/GetAtomicNumber and GET /periodicTables/GetAtomicWeight.
  4. Click on GetAtomicNumber and in the elementName parameter field, enter the name of an element, for example, “Gold” or “Oxygen”. In the Response Body field, you’ll see an XML response from the web service that looks something like this (NOTE: line feeds have been added in the example below for readability, but in practice the response will be on a single line):

     "GetAtomicNumberResult": "<NewDataSet>\r\n  <Table>\r\n    
     <Density>7874</Density>\r\n  </Table>\r\n</NewDataSet>"

Additional example code

The app includes two other files periodictable-ws.js and stock-ws.js that illustrate other ways of programmatically calling a SOAP web service. NOTE: the stock quote web service may not be consistently available.

Recreate the app

Prerequisites: If you haven’t already done so, follow the Installation instructions for the LoopBack CLI. In a nutshell:

$ npm install -g loopback-cli

To create this app yourself, follow the steps in this section:

Scaffold the app

Scaffold a new application. Enter this command:

$ lb app

When prompted, respond as follows:

  1. What's the name of your application?
    Give the app any name you wish, for example “my-soap-demo”. The tool will create a directory with that name (my-soap-demo).
  2. Enter name of the directory to contain the project:
    Press Enter to accept the default (directory has the same name as the app).
  3. Which version of LoopBack would you like to use?
    Choose 3.x (current)
  4. What kind of application do you have in mind?
    Choose empty-server (An empty LoopBack API, without any configured models or datasources)

The tool will then scaffold the app and install all the dependencies from npm.

Create a SOAP data source

Go into the app root directory:

$ cd my-soap-demo

Use the data source generator to add a SOAP data source to your application. Enter this command:

$ lb datasource

When prompted, respond as follows:

  1. Enter the datasource name:
    Enter “soapDS”.
  2. ` Select the connector for soapDS: <br/>Use your arrow key to scroll down to SOAP webservices (supported by StrongLoop)` and press Enter.
  3. URL to the SOAP web service endpoint:
    Copy and paste the URL of the periodic table web service:
  4. HTTP URL or local file system path to the WSDL file:
    Copy and paste this URL of the periodic table web service WSDL:
  5. Expose operations as REST APIs: (Y/n)
    Press Enter to accept the default (yes).
  6. Maps WSDL binding operations to Node.js methods:
    Copy and paste the stringified JSON below. The JSON defines the service, port, and operation for each operation that will be called in the SOAP service.

    NOTE: The JSON you enter must not have any line endings, that is, it must be on a single line.

  7. Install loopback-connector-soap@^3.0
    Press Enter to install the connector from npm.

The data source generator then creates an entry for the data source in the server/datasources.json file and installs all the necessary dependencies.

Create a periodicTable model

Use the model generator to add a model to represent the periodic Table web service. Enter this command:

$ lb model

When prompted, respond as follows:

  1. Enter the model name:
    Enter “periodicTable”.
  2. Enter the model name: periodicTable
    Select soapDS that you previously created.
  3. Select model's base class Select Model.
  4. Expose periodicTable via the REST API? (Y/n)
    Press Enter to accept the default (yes).
  5. Custom plural form (used to build REST URL):
    Press Enter for no custom plural.
  6. Common model or server only?
    Select server because this will be a server-only model.
  7. Property name:
    Press Enter when first prompted, because this model will not have any properties.

The tool will create two files in the server directory: periodicTable.json and periodicTable.js.

Add remote methods

Edit server/models/periodic-table.js and add the code shown below to the stubbed-out function.

This code defines two functions, Periodictable.getAtomicnumber and Periodictable.getAtomicweight and adds them as remote methods to the Periodictable model, as described in Remote methods.

'use strict';

module.exports = function(Periodictable) {

  // External PeriodTable WebService operation exposed as REST APIs through LoopBack
  Periodictable.getAtomicnumber = function (elementName, cb) {
    Periodictable.GetAtomicNumber({ElementName: elementName || 'Copper'}, function (err, response) {
      var result = response;
      cb(err, result);

  // External PeriodTable WebService operation exposed as REST APIs through LoopBack
  Periodictable.getAtomicweight = function(elementName, callback) {
    Periodictable.GetAtomicWeight({ElementName: elementName || 'Copper'}, function (err, response) {
      var result = response;
      callback(err, result);

  // Map to REST/HTTP
      'getAtomicnumber', {
        accepts: [
          {arg: 'elementName', type: 'string', required: true,
            http: {source: 'query'}}
        returns: {arg: 'result', type: 'object', root: true},
        http: {verb: 'get', path: '/GetAtomicNumber'}

      'getAtomicweight', {
        accepts: [
          {arg: 'elementName', type: 'string', required: true,
            http: {source: 'query'}}
        returns: {arg: 'result', type: 'object', root: true},
        http: {verb: 'get', path: '/GetAtomicWeight'}


Try it out!

Now, run your app:

node .

Follow the same steps as before and your app should behave the same as the one in this repository.

Tags: example_app