node-odata: 基于 NodeJS 的 REST 框架

该开源项目目前已被 OData 官网 (odata.org)收录

关于 node-odata

node-odata 可以让你轻松创建 REST API, 并能使用 OData 协议的格式进行数据的查询. 它让你可以更方便的创建 API 服务, 使你更专注于业务逻辑的处理.

什么是 OData 协议?

OData 全称开放数据协议(Open Data Protocol), 是一个用于 web 的数据访问协议. OData 提供了一个统一的 CRUD (create, read, update, and delete) 操作来查询和维护数据集.

为什么使用 node-odata?

node-odata 同时结合了 OData 强大的数据查询能力以及 NodeJS 高并发能力的优势, 使开发者能快速的创建一个高性能并支持各种复杂查询的 REST API.

在常规的 REST 框架中, 仅仅提供了 REST 风格的 CRUD 操作. 开发者不的不对每一个资源都手动添加一些公共功能, 如排序/分页等, 甚至在复杂的业务场景中, 开发者不的不一次次根据业务需求制定一些特定的复杂查询, 这都极大的浪费了人力资源. OData数据访问协议很好的解决了这一问题. 它定义了$filter, $orderby, $select等一系列关键字来进行统一的筛选, 排序, 分页等操作. 极大的减轻了开发者的负担, 提高了生产力.

反观 OData 社区, 目前 node-odata 是唯一一款基于 NodeJS 的 OData 实现. 与其它编译型语言的 OData 实现相比, 它运行更加高效, 部署更加方便, 编写更加简单 (最短只需3行代码即可初始化一个 OData 服务).

0) Demo

OData最大的特点就是他完全暴露的数据接口, 服务端只需要几行代码就能让客户端实现随心所欲的查询, 您可以试试:

• GET /books
• GET [/books?$select=title, author](http://books.zackyang.com/odata/books?$select=title, author)
• GET /books?$top=3&$skip=2
• GET [/books?$orderby=price desc](http://books.zackyang.com/odata/books?$orderby=price desc)
• GET [/books?$filter=price gt 10](http://books.zackyang.com/odata/books?$filter=price gt 10)
• ...

很酷炫, 是吗? 你还可以任意组合查询条件, 以实现复杂查询. 比如:

• 我想看看最贵的一本书是啥名字 GET [/books?$select=title&$top=1&orderby price desc](http://books.woshinidezhu.com/odata/books?$select=title, author)
• 我想看看包含'Microsoft'关键字中, 按最便宜的排序 GET [/books?$filter=indexof(title,'Microsoft') ge 0 &$orderby=price desc](http://books.woshinidezhu.com/odata/books?$filter=price gt 10&$orderby=price desc)
• ...

1) 安装

node-odata 的运行需要依赖于 NodeJS 和 MongoDB, 在安装了依赖项之后, 运行以下命令即可:

$ npm install node-odata

2) 快速开始

这里我们讲创建并运行一个最简单的 OData 服务.

2.1 创建服务

安装完成后, 新建 index.js 文件并输入:

var odata = require('node-odata');

odata.set('db', 'mongodb://localhost/my-app');

odata.resources.register({
    url: '/books',
    model: {
        title: String,
        price: Number
    }
});

odata.listen(3000);

2.2 运行服务

保存后输入以下命令即可启动 OData 服务:

$ node index.js

它将自动注册以下路由:

GET    /odata/books
GET    /odata/books/:id
POST   /odata/books
PUT    /odata/books/:id
DELETE /odata/books/:id

(点击 这里 查看完整文档)

(查看 GitHub Page 请点击 这里)