pip-clients-guides-node

Guides Microservice Client SDK for Node.js

This is a Node.js client SDK for pip-services-guides microservice. It provides an easy to use abstraction over communication protocols:

• HTTP client
• Seneca client (see http://www.senecajs.org)
• AWS Lambda client
• Direct client

Quick Links:

• Development Guide
• API Version 1

Install

Add dependency to the client SDK into package.json file of your project

{
    ...
    "dependencies": {
        ....
        "pip-clients-guides-node": "^1.0.*",
        ...
    }
}

Then install the dependency using npm tool

# Install new dependencies
npm install

# Update already installed dependencies
npm update

Use

Inside your code get the reference to the client SDK

var sdk = new require('pip-clients-guides-node');

Define client configuration parameters that match configuration of the microservice external API

// Client configuration
var config = {
    connection: {
        protocol: 'http',
        host: 'localhost', 
        port: 8080
    }
};

Instantiate the client and open connection to the microservice

// Create the client instance
var client = sdk.GuidesHttpClientV1(config);

// Connect to the microservice
client.open(null, function(err) {
    if (err) {
        console.error('Connection to the microservice failed');
        console.error(err);
        return;
    }
    
    // Work with the microservice
    ...
});

Now the client is ready to perform operations

// Create a new guide
client.createGuide(
    null,
    { 
        type: 'introduction',
        app: 'Test App 1',
        pages: [
            { 
                title: { en: 'Welcome to Test App 1' } 
            }
        ]
    },
    function (err, guide) {
        ...
    }
);

// Get a random intro guide for app1
client.getRandomGuide(
    null,
    {
        type: 'introduction',
        app: 'app1'
    },
    function(err, guide) {
        ...    
    }
);

Acknowledgements

This client SDK was created and currently maintained by Sergey Seroukhov.