A simple package to map your routes for your expressjs application
IMPORTANT: v1.0.2 fixed a security vulnerability. Every version up to v1.0.1 is not safe for production. Update your current version to v1.0.2 or higher. You can find more information here.
$ npm i -S express-routes-mapperor
$ yarn add express-routes-mapperAfter the installation you can import the package to your express project.
Create your routes file:
const routes = {
'POST /user': 'UserController.create'
};
export default routes; // module.exports = routes;Every post request to your server to route '/user' will call the function 'create' on the 'UserController'.
Create a file named UserController.js
// es6 class syntax
export default class UserController {
create (req, res) {
res.send('created a User with es6 class syntax');
};
};
// object factory pattern
const UserController = () => {
const create = (req, res) => {
res.send('created a User with without es6 class syntax');
};
return {
create,
};
};
export default UserController; // module.exports = UserController;Middlewares allow you perform any set of operation on a particular route. They are executed from top-to-bottom, as they are arranged in the middlewares array.
To proceed to the next middleware or the controller, never forget to call the next() function.
For more examples, See Middleware Example.
Middlewares can be added to a general set of routes. Such middlewares would be executed before any of the controller methods are called.
const groupedMiddleware1 = (req, res, next) => {
next();
};
const groupedMiddleware2 = (req, res, next) => {
next();
};
const router = mapRoutes(routes, 'test/fixtures/controllers/', [groupedMiddleware1, groupedMiddleware2]);Middlewares can also be added to just a single route path.
const checkIfAutheticated = (req, res, next) => {
console.log('authenticated');
next();
};
const verifyFacebookAuth = (req, res, next) => {
console.log('unverified');
return res
.status(400)
.json({status: false, message: 'Sorry, you aren\'t authorized on facebook'});
};
const routes = {
'GET /user:id': {
path: 'UserController.get',
middlewares: [
checkIfAutheticated,
verifyFacebookAuth,
],
},
'POST /user': 'UserController.create'
};I assume you have a folder structure like this, but it can be adapted to any folder structure.
.
+-- src
| +-- config
| | +-- routes.js
| |
| +-- controllers
| | +-- UserController.js
| |
| +-- models
| |
| app.js
|
package.jsonYour app.js could look a bit like this:
The magic happens here:
import routes from './config/routes';the file where all the routes are mappedimport mapRoutes from 'express-routes-mapper';the package that makes the mapping possibleconst mappedRoutes = mapRoutes(routes, 'src/controllers/');tell router to use your routesapp.use('/', mappedRoutes);tell express to use the mapped routes
import express from 'express'; // const express = require('express');
import http from 'http'; // const http = require('http');
import mapRoutes from 'express-routes-mapper'; // const mapRoutes = require('express-routes-mapper');
import routes from './config/routes'; // const routes = require('./config/routes');
const app = express();
const server = http.Server(app);
const port = 4444;
// mapRoutes takes two arguments
// - 1. the routes
// - 2. the path to your controllers from process.cwd();
const mappedRoutes = mapRoutes(routes, 'src/controllers/');
app.use('/', mappedRoutes);
server.listen(port, () => {
console.log('There we go ♕');
console.log(`Gladly listening on http://127.0.0.1:${port}`);
});All routes supported by the express framework is natively supported by this library (e.g. GET, PUT, POST, DELETE etc.).
const routes = {
'GET /someroute' : 'SomeController.somefunction',
'POST /someroute' : 'SomeController.somefunction',
'PUT /someroute' : 'SomeController.somefunction',
'DELETE /someroute' : 'SomeController.somefunction',
// etc.
};Simply use a colon : for defining dynamic routes.
const routes = {
'GET /someroute/:id' : 'SomeController.someFunction',
};If you make a get request to http://localhost/someroute/1 the number 1 (:id) is now in the SomeController accessible.
// object factory pattern
const SomeController = () => {
const someFunction = (req, res) => {
const id = req.params.id;
// do some fency stuff with the id
};
return {
someFunction,
};
};
export default SomeController; // module.exports = SomeController;- Fork it!
- Create your feature branch:
git checkout -b feature-name - Commit your changes:
git commit -am 'Some commit message' - Push to the branch:
git push origin feature-name - Submit a pull request 😉😉
MIT © Lukas Aichbauer
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent