moleculer-web

Official API Gateway for Moleculer framework

The moleculer-web is the official API gateway service for Moleculer. Use it to publish your services.

Features

• support HTTP & HTTPS
• serve static files
• multiple routes
• alias names
• whitelist
• multiple body parsers (json, urlencoded)
• Buffer & Stream handling

Install

npm install moleculer-web --save

Usage

Run with default settings

This example uses API Gateway service with default settings. You can access to all services (including internal $node.) via http://localhost:3000/

let { ServiceBroker } = require("moleculer");
let ApiService = require("moleculer-web");

// Create broker
let broker = new ServiceBroker();

// Load your services
broker.loadService(...);

// Load API Gateway
broker.createService(ApiService);

// Start server
broker.start();

Example URLs:

• Call test.hello action: http://localhost:3000/test/hello

• Call math.add action with params: http://localhost:3000/math/add?a=25&b=13

• Get health info of node: http://localhost:3000/~node/health

• List all actions: http://localhost:3000/~node/actions

Service settings

settings: {

	// Exposed port
	port: process.env.PORT || 4000,

	// Exposed IP
	ip: process.env.IP || "0.0.0.0",

	// HTTPS server with certificate
	https: {
		key: fs.readFileSync("ssl/key.pem"),
		cert: fs.readFileSync("ssl/cert.pem")
	},

	// Exposed path prefix
	path: "/api",

	// Routes
	routes: [
		{
			// Path prefix to this route  (full path: /api/admin )
			path: "/admin",

			// Whitelist of actions (array of string mask or regex)
			whitelist: [
				"users.get",
				"$node.*"
			],

			// Under development
			authorization: true,

			// Action aliases
			aliases: {
				"POST users": "users.create",
				"health": "$node.health"
			},

			// Use bodyparser module
			bodyParsers: {
				json: true,
				urlencoded: { extended: true }
			}
		},
		{
			// Path prefix to this route  (full path: /api )
			path: "",

			// Whitelist of actions (array of string mask or regex)
			whitelist: [
				"posts.*",
				"file.*",
				/^math\.\w+$/
			],

			authorization: false,
			
			// Action aliases
			aliases: {
				"add": "math.add",
				"GET sub": "math.sub",
				"POST divide": "math.div",
			},
			
			// Use bodyparser module
			bodyParsers: {
				json: false,
				urlencoded: { extended: true }
			}
		}
	],

	// Folder to server assets (static files)
	assets: {

		// Root folder of assets
		folder: "./examples/www/assets",
		
		// Options to `server-static` module
		options: {}
	}
}

Examples

• Simple
• SSL server
• WWW with assets
• All features

Test

$ npm test

In development with watching

$ npm run ci

Contribution

Please send pull requests improving the usage and fixing bugs, improving documentation and providing better examples, or providing some testing, because these things are important.

License

Moleculer-web is available under the MIT license.

Contact

Copyright (c) 2017 Ice-Services

Changelog

0.1.0 (2017-05-08)

First release.