Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gustavohenrique/restify-route
Simplifies the restify route creation
https://github.com/gustavohenrique/restify-route
Last synced: about 1 month ago
JSON representation
Simplifies the restify route creation
- Host: GitHub
- URL: https://github.com/gustavohenrique/restify-route
- Owner: gustavohenrique
- Created: 2015-01-18T15:05:10.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2016-02-21T15:05:48.000Z (almost 9 years ago)
- Last Synced: 2024-10-29T01:21:15.563Z (2 months ago)
- Language: JavaScript
- Size: 11.7 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
restify-route
=============
A lazy way to create restify routes with support jwt.
[](http://travis-ci.org/gustavohenrique/restify-route)
[](https://gemnasium.com/gustavohenrique/restify-route)
## Quick start
```javascript
var restify = require('restify');
var routes = require('restify-route');
var server = restify.createServer();
routes
.use(server)
.set('/contact/:id', 'get', function (req, res) {
res.send('The sent ID: ' + req.params.id);
})
.set('/contact/create', 'post', function (req, res) {
// validation code here
res.send(201, 'created');
})
.set('/contact/delete/:id', 'del', function (req, res) {
res.send('deleted');
})
.set('/contact/update', 'put', function (req, res) {
res.send('updated');
});
server.listen(3000, '127.0.0.1', function () {
console.log('Running on http://127.0.0.1:3000');
});
```
## Using with Json Web Token (JWT)
The example below requires an user authenticated to consume the endpoint `/contact/delete/:id`.
You can set `allwaysVerifyAuthentication: true` and all endpoints will require an user authenticated, except the endpoint with `false` as fourth parameter.
```javascript
var restify = require('restify');
var routes = require('restify-route');
var server = restify.createServer();
routes
.use(server)
.jwt({
secretOrPrivateKey: 'mysecret',
allwaysVerifyAuthentication: false,
callback: function (req, next, decoded) {
// register the data decoded from token
req.user = decoded;
next();
}
})
.set('/contact/:id', 'get', function (req, res) {
res.send('The sent ID: ' + req.params.id);
})
.set('/contact/create', 'post', function (req, res) {
// validation code here
res.send(201, 'created');
})
.set('/contact/delete/:id', 'del', function (req, res) {
res.send('deleted');
}, true)
.set('/contact/update', 'put', function (req, res) {
res.send('updated');
});
server.listen(3000, '127.0.0.1', function () {
console.log('Running on http://127.0.0.1:3000');
});
```
See the `tests` for more information.