@piigo/expresslib

ExpressLib

A simple yet powerfull Express library to build REST API using Express, MongoDB and Redis.

Features

• Easy to setup using environment variables
• Custom middlewares for JSON Web Tokens, API Key and Secret, JSON-Schema validation.
• Security by default, using helmet to protect your app
• Simple HTTP error management using throw and stack.HttpError
• Redis and MongoDB client included
• Gracefull shutdown (Not Yet Implemented)
• JSON Web Tokens utils like sign, verify, and refresh

Quick Start

Install

$ npm install @piigo/expresslib

Create .env

Create a new file named .env and then add the following text

mongoUrl=<Your MongoDB connection url, ex: localhost:27017>
redisUrl=<Your redis url under the format host:port, ex: localhost:6379>
redisAuth=<Redis password, ex: qwerty>

appHost=<Address on which the http server will listen, ex: 0.0.0.0>
appPort=<Port on which the http server will listen, ex: 80>

jwtSecretKey=<Secret key to sign your JWT with, should be at least of 256 bits (1 character = 8 bits), ex: qwerty>
jwtExpiresIn=<Amount of time that your JWT will be valid, ex: 10m>

tokensPrefix=<Prefix to use for every apiKey and apiSecret, ex: tokens.>

Note: Currently you can provide environment variables throught a .env file. You can still load environment variables in other way but don't forget to always have at least an empty .env file, otherwise application will crash. A better support for environment variables will be provided in the near future, but pull request are always welcome.

Usage

const stack = require("@piigo/expresslib");
const middlewares = stack.middlewares;

const schema = {
    $schema: "http://json-schema.org/draft-07/schema",
    type: "string",
}

const router = stack.router();
router.get("/", (req, res) => res.send("Hello world!"));
router.get("/needApiKey", middlewares.apiKey, (req, res) => res.send("Access authorized " + req.appId));
router.get("/needApiSecret", middlewares.apiSecret, (req, res) => res.send("Access authorized " + req.appId));
router.post("/mustFollowSchema", middlewares.validateBody(schema), (req, res) => res.send("Schema is valid"));
router.get("/error", (req, res) => {throw new stack.HttpError("cancelled", "It works")});

stack.use(router);
stack.start();