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.

express-router's Issues

Version 10 of node.js has been released

Version 10 of Node.js (code name Dubnium) has been released! 🎊

To see what happens to your code in Node.js 10, Greenkeeper has created a branch with the following changes:

• Added the new Node.js version to your .travis.yml

If you’re interested in upgrading this repo to Node.js 10, you can open a PR with these changes. Please note that this issue is just intended as a friendly reminder and the PR as a possible starting point for getting your code running on Node.js 10.

More information on this issue

Greenkeeper has checked the engines key in any package.json file, the .nvmrc file, and the .travis.yml file, if present.

• engines was only updated if it defined a single version, not a range.
• .nvmrc was updated to Node.js 10
• .travis.yml was only changed if there was a root-level node_js that didn’t already include Node.js 10, such as node or lts/*. In this case, the new version was appended to the list. We didn’t touch job or matrix configurations because these tend to be quite specific and complex, and it’s difficult to infer what the intentions were.

For many simpler .travis.yml configurations, this PR should suffice as-is, but depending on what you’re doing it may require additional work or may not be applicable at all. We’re also aware that you may have good reasons to not update to Node.js 10, which is why this was sent as an issue and not a pull request. Feel free to delete it without comment, I’m a humble robot and won’t feel rejected 🤖

---

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.

---

Your Greenkeeper Bot 🌴