
Security News
Deno 2.2 Improves Dependency Management and Expands Node.js Compatibility
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.
express-api-routes
Advanced tools
Node.js Express auto route & policy contructor for app servers
This module is designed to be used in a Node.js Express.js server. It allows you
to build routes/endpoints by simply declaring functions (in your controller files).
All functions in the controllers/myPath.js
will be available at the endpoint
/myPath/{functionName}
- they are automatically bound to the express
app
router
.
It also allows you to define policy "middleware" that is processed before the
request gets to your endpoint.
Node v4
npm install --save express-api-routes
- controllers/
- user.js
- policies/
- loggedIn.js
- config/
- routes.js
- package.json
- app.js
/app.js
const app = require('express')();
const expressApiRoutes = require('expressApiRoutes');
// initialize with a config file
const api = new expressApiRoutes({
// Logger (winston instance) {optional}
logger: new winston.Logger,
// Root directory
root: __dirname, // defaults to process.mainModule.filename.dir
// Base route {optional}
baseRoute: '/api', // defaults to '/'
// Controllers directory {required} absolute path to controllers dir
controllers: __dirname + "/controllers", // default if none provided
// Policies directory {optional} absolute path to policies dir
policies: __dirname + "/policies", // default if none provided
// Routes Config Object {optional}
routes: require('./config/routes'),
// Express instance {optional}
app: app, // creates an express app if none provided
});
console.log(api); // { controllers: {..}, policies: {..}, routesMap: [..] }
app.listen(3000);
/controllers/user.js
module.exports = {
index(req,res,next) {
// localhost:3000/api/user
return res.send('Woohoo!');
},
someOtherAction(req,res,next) {
// localhost:3000/api/user/someOtherAction
return res.send('action, bam!');
}.
getUsers(req,res,next) {
// do some database work...
return res.send('Send users list!');
}
};
/policies/loggedIn.js
module.exports = (req,res,next) => {
console.log('Policy checking login credentials');
next();
};
/config/routes.js
module.exports = {
'/users/list': {
controller: 'user',
method: 'getUsers',
policies: ['loggedIn']
}
};
Now going to your browser localhost:3000/api/users/list
will run the
function getUsers()
from the controller file /controllers/user.js
FAQs
Node.js Express auto route & policy contructor for app servers
The npm package express-api-routes receives a total of 2 weekly downloads. As such, express-api-routes popularity was classified as not popular.
We found that express-api-routes demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.
Security News
React's CRA deprecation announcement sparked community criticism over framework recommendations, leading to quick updates acknowledging build tools like Vite as valid alternatives.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.