To help you get started, we've collected the most common ways that moleculer-web is being used within popular public projects.

gothinkster / moleculer-node-realworld-example-app / services / api.service.js View on Github

"use strict";

const _ = require("lodash");
const ApiGateway = require("moleculer-web");
const { UnAuthorizedError } = ApiGateway.Errors;

module.exports = {
	name: "api",
	mixins: [ApiGateway],

	settings: {
		port: process.env.PORT || 3000,

		routes: [{
			path: "/api",

			authorization: true,

			aliases: {
				// Login
				"POST /users/login": "users.login",

View more ways to use 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
• support global, route, alias middlewares
• support file uploading
• alias names (with named parameters & REST shorthand)
• whitelist
• multiple body parsers (json, urlencoded)
• CORS headers
• ETags
• HTTP2
• Rate limiter
• before & after call hooks
• Buffer & Stream handling
• middleware mode (use as a middleware in ExpressJS Application)
• support authorization

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 https://localhost:3000/

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

let broker = new ServiceBroker({ logger: console });

// Create a service
broker.createService({
    name: "test",
    actions: {
        hello() {
            return "Hello API Gateway!"
        }
    }
});

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

// Start server
broker.start();

Test URLs:

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

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

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

Documentation

Please read our documentation on Moleculer site

Test

$ npm test

In development with watching

$ npm run ci

License

Moleculer-web is available under the MIT license.

Contact

Copyright (c) 2016-2021 MoleculerJS