bm-vslice-layered-client-products-node
v1.0.2
Published
This is a Node.js client SDK for [service-products-node](https://bitbucket.org/entinco/bm-verticalslice-ecommerce) microservice. It provides an easy to use abstraction over communication protocols:
Downloads
1
Readme
Products Microservice Client SDK for Node.js
This is a Node.js client SDK for service-products-node 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:
Install
Add dependency to the client SDK into package.json file of your project
{
...
"dependencies": {
....
"bm-vslice-layered-client-products-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-products-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.ProductsHttpClientV1(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 product
var product = {
id: '1',
name: 'product one',
description: 'Description of product one',
in_stock: 5,
price: 100,
discount: 0.07,
discount_price: 93,
category: 'category1',
product_brand: 'brand1',
};
client.createProduct(
null,
product,
function (err, product) {
...
}
);
// Get the list of products
client.getProducts(
null,
{
product_id: '1'
},
{
total: true,
skip: 0,
take: 10
},
function(err, page) {
...
}
);
Contacts
This repository was created by and is currently maintained by Dmitriy Krayniy and Denis Kuznetsov.