Respectify

Route specification for restify

Table of Contents

• Usage
• API
• Install
• License

Usage

var restify = require('restify')
  , Respectify = require('respectify')
 
// Create the restify server
var server = restify.createServer()
 
server.get({
  path: '/things/:id'
, version: '1.0.0'
, params: {
    id: 'number'
  , another: {
      dataTypes: ['number', 'string']
    , default: 20
    }
  }
}, function(req, res, next) {
  ...
})
 
// Create the respectify instance with the new server
var respect = new Respectify(server)
 
// Add the respectify middleware to validate routes
server.use(respect.middleware)

A params object must be added to the route options in order for Respectify to parse and / or validate the route.

• dataTypes - one of the following: number, date, string, array, object, boolean
• default - the default value to use if the param was not sent
• dataValues - array of specific values considered valid

{
  one: 'array'
, two: ['date', 'number']
, three: {
    dataTypes: ['string', 'number']
  , default: 20
  , dataValues: [10, 'a', 30]
  }
}

API

new Respectify(server)

Respectify constructor

Alias: [Respectify.factory(server)]

• server - restify server instance

Example:

var server = restify.createServer()
var respect = new Respectify(server)

instance.middleware

Route middleware to add parameter validation, this will filter all properties of req.params according to the param definition of the route. Parameters received that have not been defined will be removed.

Example:

server.use(respect.middleware)

server.get({
  path: '/'
, version: '1.0.0'
, params: {}
}
, respect.middleware()
, function(req, res, next) {
  
  // req.params has been cleaned and validated

})

Install

With npm

npm install respectify

License

(The MIT License)

Copyright (c) 2013 Major League Soccer

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.