@korbiniankuhn/express-router

Express router

Build REST API endpoints for Express dynamically. The middleware sends automated 404 and 405 responses with endpoint / allowed methods suggestions. The routes and controllers can easily be described with an object. It also validates the given object against duplicate endpoints and missing controller functions.

Installation

For installation use the Node Package Manager:

$ npm install --save @korbiniankuhn/express-router

or clone the repository:

$ git clone https://github.com/KorbinianKuhn/express-router

Getting started

Define your api endpoints / app routing.

const controller = require('./path/to/controller');
const routes = {
  '/users': {
    get: controller.getUsers,
    post: controller.addUser,
    '/:id': {
      get: controller.getUserById,
      delete: controller.deleteUserById,
      patch: controller.changeUser,
      '/photos/:id/thumbnail': {
        get: controller.getThumbnailByPhotoId
      }
    }
  }
}

Create the endpoints

const { Router } = require('@korbiniankuhn/express-router');
const express = require('express');
const app = express();

const router = Router();

router.create(app);

Add the 404, 405 middleware

app.use(router.middleware());

Settings

create(app, routes, middleware, options)

• app The express app instance.
• routes The routes object.
• middleware A middleware that should be used for all routes.

options

• asyncWrapper (boolean): Wraps an async middleware around the controller function that catches exceptions and nexts them. Default true.
• verbose (function): Set a function e.g. console.log to see outputs for all created routes. Default null.
• strict (boolean): Only allow routes that contain lowercase letters, numbers or dashes. Default true.

middleware(routes, options)

• routes The routes object.

options

• next (boolean): Next a NotFoundError or MethodNotAllowedError after sending response. Default false.
• messageNotFound (string): Set a custom message for 404 errors. Default 'Not found.'
• nameNotFound (string): Set a custom error name for 404 errors. Default 'not_found'
• messageMethodNotAllowed (string): Set a custom message for 405 errors. Default 'Method not allowed.'
• nameMethodNotAllowed (string): Set a custom error name for 405 errors. Default 'method_not_allowed'
• strict (boolean): Only allow routes that contain lowercase letters, numbers or dashes. Default true.

Testing

First you have to install all dependencies:

$ npm install

To execute all unit tests once, use:

$ npm test

To get information about the test coverage, use:

$ npm run coverage

Contribution

express-router is an open source project and your contribution is very much appreciated. Fork this repository and push in your ideas.

Do not forget to add corresponding tests to keep up 100% test coverage.

License

The MIT License

Copyright (c) 2018 Korbinian Kuhn

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.