client-applications-node v1.1.1

Applications Microservice Client SDK for Node.js / ES2017

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

• Direct client
• HTTP client
• Seneca client (see http://www.senecajs.org)
• AWS Lambda client (see https://aws.amazon.com/lambda)

Quick Links:

• Development Guide
• API Version 1

Install

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

{
    ...
    "dependencies": {
        ....
        "client-applications-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('client-applications-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.ApplicationsHttpClientV1(config);

// Connect to the microservice
try {
    await client.open(null);
    // Work with the microservice
    ...
}
catch(err) {
    console.error('Connection to the microservice failed');
    console.error(err);
}

Now the client is ready to perform operations

// Create a new application
var application = {
    id: 'my_app',
    name: 'My Application',
    product: 'My Samples'
};

let application = await client.createApplication(
    null,
    application
);

// Get the list of applications for 'My Samples' product
let page = await client.getApplications(
    null,
    {
        product: 'My Samples'
    },
    {
        total: true,
        skip: 0,
        take: 10
    }
);

Acknowledgements

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