apis-resource

0.4.0 • Public • Published

apis-resource

Add resource helper for apis lib

Resource

res.resource = 'user',
res.get = function(auth, data, cb) {};
res.create = function(auth, data, cb) {};

request or response

request = {
    get: function() {
        return {email: email}
    },
 
    create: function() {
        return {
            email: email,
            password: str,
            name: opt(str),
        }
    }
}

Usage

add(
    contract,       //contract handler 
    {
        handler     //auth handler
        authFunc    //auth function
    },           
    {
        base,       //api base path, ex. '/api'
        api,        //resource api unit
        request,    //request validators
        response    //optional, response validators
    }
)

Example

var addResource = require('apis-resource').add;
...
 
Contract.prototype.unitInit = function (units) {
    var auth =  units.require('auth').handler;
    var userApi =  units.require('user.api');
    var userRequest =  units.require('user.request');
 
    add(this, {handler: auth}, {
        base: '/api/1', 
        api: userApi, 
        request: userRequest
    });
};

Readme

Keywords

Package Sidebar

Install

npm i apis-resource

Weekly Downloads

7

Version

0.4.0

License

none

Last publish

Collaborators

  • velocityzen