1.1.4 • Published 9 years ago

express-restify v1.1.4

Weekly downloads
1
License
ISC
Repository
github
Last release
9 years ago

#express-restify


##Purpose A module for making REST full calls easy with mongoose and express.

##Install

$ npm install express-restify

##Suited Database && Framework && API`s

express-restify suited for below specified frameworks and database only.

Database    - **MongoDB**
Framework   - **Express**
API         - **mongoose**

API:

var REST = require('express-restify')(app);

##REST REST object contains a register method for registering with REST services.

###REST.register(options) Create a REST middleware with the given options.

####Options express-restify accepts these properties in the options object.

#####url An url of the route for REST service.

#####model Model name of a mongoose collection.

#####restrict An array to restrict the properties while retrieving the data from the database.

REST.register({
      url: '/api/users',
      model: 'User',
      restrict: ['password']
});

So in this we are restricting the password feild, this won't be supplied to browser in any query response.

###Example The first step is load the express, mongoose and store the instance of an express in a variable.

var app = require('express')(),
      mongoose = require('mongoose'),

The second step is create a connection to the mongodb using mongoose.connect, create a new Schema with required properties and create a model using mongoose.model.

var UserSchema = new mongoose.Schema({name: String, password: String, address: String}});
var UserModel = mongoose.model('User', UserSchema, 'users');

The third step is load the express-restify module and call the method with an argument aninstance of express variable.

var REST = require('express-restify')(app);

The fourth step Registration and this will take care of all the REST functionalities.

REST.register({
      url: '/api/users',
      model: 'User'
});

Example

Refer the sample application at following link test-express-restify

1.1.4

9 years ago

1.1.3

10 years ago

1.1.2

10 years ago

1.1.1

10 years ago

1.1.0

10 years ago

1.0.3

10 years ago

1.0.2

10 years ago

1.0.1

10 years ago

1.0.0

10 years ago