Moleculer is a fast, modern and powerful microservices framework for Node.js (>= v6.x).
Website: https://moleculer.services
Documentation: https://moleculer.services/docs
- Promise-based solution
- request-reply concept
- support event driven architecture with balancing
- built-in service registry
- dynamic service discovery
- load balanced requests & events (round-robin, random, cpu-usage)
- supports middlewares
- service mixins
- multiple services on a node/server
- built-in caching solution (memory, Redis)
- pluggable transporters (TCP, NATS, MQTT, Redis, NATS Streaming, Kafka)
- pluggable serializers (JSON, Avro, MsgPack, Protocol Buffer)
- pluggable validator
- all nodes are equal, no master/leader node
- parameter validation with fastest-validator
- distributed timeout handling with fallback response
- health monitoring, metrics & statistics
- supports versioned services
- official API gateway module and many other modules...
$ npm install moleculer --save
or
$ yarn add moleculer
This example shows you how to create a small service with an add
action which can add two numbers.
const { ServiceBroker } = require("moleculer");
let broker = new ServiceBroker({ logger: console });
broker.createService({
name: "math",
actions: {
add(ctx) {
return Number(ctx.params.a) + Number(ctx.params.b);
}
}
});
broker.start();
// Call service
broker.call("math.add", { a: 5, b: 3 })
.then(res => console.log("5 + 3 =", res))
.catch(err => console.error(`Error occured! ${err.message}`));
Use the Moleculer CLI tool to create a new Moleculer based microservices project.
-
Install moleculer-cli globally
$ npm install moleculer-cli -g
-
Create a new project (named
first-demo
)$ moleculer init project first-demo
Press Y on API Gateway &
npm install
-
Open project folder
$ cd first-demo
-
Start project
$ npm run dev
-
Open the http://localhost:3000/api/greeter/welcome?name=world link in your browser. It will call the
welcome
action ofgreeter
service with aname
param via API gateway and returns with the result.
🎉Congratulations! Your first Moleculer based microservices project is created. Read our documentation to learn more about Moleculer.
We have many official modules for Moleculer. Check our list!
Moleculer is an open source project. It is free to use for your personal or commercial projects. However, developing it takes up all my free time to make it better and better on a daily basis. If you like Moleculer framework, please support it.
Thank you very much!
You can find here the documentation.
See CHANGELOG.md.
We welcome you to join to the development of Moleculer. Please read our contribution guide.
Moleculer is available under the MIT license.
Copyright (c) 2016-2018 MoleculerJS