microservice-base

Microservice base library for Node.js to handle most boiler plate of setting up a microservice.

Project Objectives

• Base for building a microservice to reduce the boiler plate code in other codebases
• Minimal project dependencies for reducing the chance of a broken build from a broken dependency
• Support for both http and https

Classes

• MicroService - Main server class
• RouteBase - Base class for routes, expects extending class to implement handleRequest (request, response)
• RouteNull - Route that always returns 404. This can be used as the default handler when only sub-routes are required.
• RouteJSON - Simple route which handles JSON parsing of the message body object. Expects extending classes to implement respond (request, response, data)
• StaticFileServer - Static file server can be used to serve files from disk

Usage

The most basic setup has one route which is setup as the default route. The default route handles all requests which don't match any other route.

1. Create the service
2. Create a route
3. Register the route as the default route
4. Start the server

Service Options

• useHttp (Default: true) When true a http server is started
• useHttps (Default: false) When true a https server is started
• port (Default: 8080) Set the listening port of the http server (if enabled)
• sslPort (Default: 8081) Set the listening port of the https server (if enabled)
• httpsOptions (Default: {}) Options to pass to the https server (to pass in the key and cert of your server)

Usage Example

Create a simple file server:

const microBase = require("microservice-base");

const fileHandler = new microBase.StaticFileServer("/", "./", "index.html");
const microserver = new microBase.MicroService({port: 8080});
microserver.registerDefaultHandler(fileHandler);
microserver.start();