client-quotes-node

Quotes Microservice Client SDK for Node.js

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

• Direct client
• HTTP client
• 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-quotes-node": "^2.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

let sdk = new require('client-quotes-node');

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

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

Instantiate the client and open connection to the microservice

// Create the client instance
let client = sdk.QuotesHttpClientV1(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 quote
let quote = {
    text: { en: 'Get in hurry slowly' },
    author: { en: 'Russian proverb' },
    tags: ['time management'],
    status: 'completed'
};

let quote = await client.createQuote(
    null,
    quote
);

// Get the list of quotes on 'time management' topic
let page = await client.getQuotes(
    null,
    {
        tags: 'time management',
        status: 'completed'
    },
    {
        total: true,
        skip: 0,
        take: 10
    }   
});

Acknowledgements

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