Skip to content

mastilver/express-annotation

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 

express-annotation Build Status Coverage Status

Bring annotation routing to expressJs

Install

$ npm install --save express-annotation

Usage

given a file /controllers/user.js:


// @route('/users')
module.exports.getAll = function(req, res){

};

// @route('/users/:id')
module.exports.get = function(req, res){
    console.log(req.params.id);
};

// @httpPut()
// @route('/users/:id')
module.exports.update = function(req, res){

};

you can register those routes by writing so:


var expressAnnotation = require('express-annotation');
var app = require('express')();

expressAnnotation(app, 'controllers/**/*.js', function(err){

    // routes have been added to the express instance

    app.listen(3030);
});

API

expressAnnotation(expressInstance, paths, callback)

expressInstance

required

express instance (value returned by: express())

paths

required
Type: array, string

callback(err)

Type: Function

will be called when all the routes have been added to the express instance

Annotations / Decorators API

Licence

MIT © Thomas Sileghem

About

Bring annotation routing to express

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published