README
Tags Microservice
This is a search tags microservice from Pip.Services library. It keeps track of search tags entered by a party (user or other party he or she represents). Later the tags can be used to enhance user experience in autocomplete and search functions.
The microservice currently supports the following deployment options:
- Deployment platforms: Standalone Process, Seneca
- External APIs: HTTP/REST, Seneca
- Persistence: Flat Files, MongoDB
This microservice has no dependencies on other microservices.
- Download Links
- Development Guide
- Configuration Guide
- Deployment Guide
- Client SDKs
- Communication Protocols
Contract
Logical contract of the microservice is presented below. For physical implementation (HTTP/REST, Thrift, Seneca, Lambda, etc.), please, refer to documentation of the specific protocol.
class PartyTagsV1 implements IStringIdentifiable {
public id: string;
public tags: TagRecordV1[];
public change_time: Date;
}
class TagRecordV1 {
public tag: string;
public count: number;
public last_time: Date;
}
interface ITagsV1 {
getTags(correlationId: string, partyId: string,
callback: (err: any, partyTags: PartyTagsV1) => void): void;
setTags(correlationId: string, partyTags: PartyTagsV1,
callback: (err: any, partyTags: PartyTagsV1) => void): void;
recordTags(correlationId: string, partyId: string, tags: string[],
callback: (err: any, partyTags: PartyTagsV1) => void): void;
}
Download
Right now the only way to get the microservice is to check it out directly from github repository
git clone git@github.com:pip-services-content/pip-services-tags-node.git
Pip.Service team is working to implement packaging and make stable releases available for your as zip downloadable archieves.
Run
Add config.yaml file to the root of the microservice folder and set configuration parameters. As the starting point you can use example configuration from config.example.yaml file.
Example of microservice configuration
- descriptor: "pip-services-container:container-info:default:default:1.0"
name: "pip-services-tags"
description: "Tags microservice"
- descriptor: "pip-services-commons:logger:console:default:1.0"
level: "trace"
- descriptor: "pip-services-tags:persistence:file:default:1.0"
path: "./data/tags.json"
- descriptor: "pip-services-tags:controller:default:default:1.0"
options:
max_tag_count: 100
- descriptor: "pip-services-tags:service:http:default:1.0"
connection:
protocol: "http"
host: "0.0.0.0"
port: 8080
For more information on the microservice configuration see Configuration Guide.
Start the microservice using the command:
node run
Use
The easiest way to work with the microservice is to use client SDK. The complete list of available client SDKs for different languages is listed in the Quick Links
If you use Node.js then you should add dependency to the client SDK into package.json file of your project
{
...
"dependencies": {
....
"pip-clients-tags-node": "^1.0.*",
...
}
}
Inside your code get the reference to the client SDK
var sdk = new require('pip-clients-tags-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.HttpRestClientV1(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
// Record tags for a user
client.recordTags(
null,
'123',
['draft', 'important'],
function (err, tags) {
...
}
);
// Get the list of user tags
client.getTags(
null,
'123',
function(err, partyTags) {
...
}
);
Acknowledgements
This microservice was created and currently maintained by Sergey Seroukhov.