關于 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 請點擊 這里)