mongoose-express-api v0.0.3

Mongoose Express Api

Flexible automatic API generation for Moongose and Express

Installation

npm install mongoose-express-api

or specify it as a dependency in package.json

"dependencies": {
  "mongoose-express-api": "*"
}

and then run npm install in your project root.

Examples

### Basic usage

MongooseExpressApi = require("mongoose-express-api");

api = new MongooseExpressApi();
api.resources(mongoose.models);

api.mount(app, "/api");

Filtering models

api.resources(mongoose.models, { skip: ["Admin"] })

Specifying allowed actions

api.resources(mongoose.models, {actions: ["read", "list"]})

Adding a single model

api.resource(myModel)

Adding a single model filtering actions

api.resource(myModel, {actions: ["read", "list"]})

Extending implementation

impl = api.getImplementation();
impl.setResponder( myResponder );
impl.addAction( "search", searchAction );

Replacing Implementation

impl = api.setImplementation( myImpl );

Securing api and middlewares

impl.use(authMiddleware, function( action, resource ){
  return action != "read" && action != "list" || resource == "Admin";
});