如何使用restify.js处理深层和复杂的数据结构

时间:2012-12-05 15:32:09

标签: javascript node.js rest restify

我已经看到Restify的例子,其中所有端点都位于根目录上:/ users,/ data等。我知道可以像这样实现嵌套:

server.get('/users/:user/data/:id', returnData);

并且req.params变量将包含所有请求参数。例如:

{ user: '45', id: '80' }

如果我的应用程序端点很少,这似乎工作正常,但如果我有一个深层和分支的数据结构,我想通过REST API公开怎么办?类似的东西:

{
  stuff: {
    points: {
      colors: {
        shinyThings: {},
        dullThings: {}
      }
    },
    ships: {
      enterprises: {},
      starDestroyers: {}
    }
  },
  things: {},
}

手工编写所有这些端点的路径似乎并不合适。我最终得到了很多路径定义和类似的东西:

server.put('/stuff/:stuff/points/:points/colors/:colors/shinyThings/:shinyThings', returnShinyThing);

使用Restify有更简单的方法吗?

1 个答案:

答案 0 :(得分:2)

我想出办法,虽然我确信有更好的选择:

1)创建模块以处理端点上的某些操作。这些模块将被用于中央路由器模块。示例stuff.js

exports.list = function(req, res, next) {
  // Code to handle a GET request to /stuff
};

exports.create = function(req, res, next) {
  // Code to handle a POST request to /stuff
};

exports.show = function(req, res, next) {
  // Code to handle a GET request to /stuff/:id
};

exports.update = function(req, res, next) {
  // Code to handle a PUT request to /stuff/:id
};

exports.destroy = function(req, res, next) {
  // Code to handle a DELETE request to /stuff/:id
};

2)在路由器模块中定义动作的映射 - > http动词:

var actions = {
  list: 'get',
  create: 'post',
  show: 'get',
  update: 'put',
  destroy: 'del'
}

3)创建一个表示数据结构的对象:

var schema = {
  stuff: {
    _actions: require('./stuff'),
    points: {
      _actions: require('./points'),
      colors: {
        _actions: require('./colors'),
        shinyThings: {_actions: require('./shinyThings')},
        dullThings: {_actions: require('./dullThings')}
      }
    },
    ships: {
      _actions: require('./ships'),
      enterprises: {_actions: require('./enterprises')},
      starDestroyers: {_actions: require('./starDestroyers')}
    }
  },
  things: {_actions: require('./things')},
}

4)在路由器初始化期间,应用程序将一个Restify服务器对象传递给它以附加路由。在初始化期间,递归函数遍历模式对象,当找到_actions密钥时,它会调用第二个函数,该函数将给定路径上的路由处理程序附加到给定服务器对象:

(function addPathHandlers(object, path) {
  for (var key in object) {
    if (key === '_actions') addActions(object, path);
    else if (typeof object[key] === 'object') {
      var single = en.singularize(path.split('/').pop());

      if (path.charAt(path.length - 1) !== '/') {
        path += ['/:', single, '_id/'].join('');
      }

      addPathHandlers(object[key], path + key);
    }
  }
})(schema, '/');

function addActions(object, path) {
  // Actions that require a specific resource id
  var individualActions = ['show', 'update', 'destroy']; 

  for (var action in object._actions) {
    var verb = actions[action];

    if (verb) {
      var reqPath = path;
      if (individualActions.indexOf(action) !== -1) reqPath += '/:id';

      server[verb](reqPath, object._actions[action]);
    }
  }
}

注意:这使用了lingo模块(即en.singularize()函数)。由于我删除了函数的非关键部分,因此它也有点简化,但它应该完全正常运行。

在看到快递资源的方式之后,灵感就来了,虽然它没有那么精致和简单易用。