本節(jié)介紹Node.js的RESTful API。
什么是 REST？
REST中文解釋為，表述性狀態(tài)傳遞（英文：Representational State Transfer，簡(jiǎn)稱(chēng)REST），是Roy Fielding博士在2000年他的博士論文中提出來(lái)的一種軟件架構(gòu)風(fēng)格。
表述性狀態(tài)轉(zhuǎn)移是一組架構(gòu)約束條件和原則。滿(mǎn)足這些約束條件和原則的應(yīng)用程序或設(shè)計(jì)就是RESTful。
需要注意的是，REST是設(shè)計(jì)風(fēng)格而不是標(biāo)準(zhǔn)。REST通?；谑褂肏TTP，URI和XML（標(biāo)準(zhǔn)通用標(biāo)記語(yǔ)言下的一個(gè)子集）以及HTML（標(biāo)準(zhǔn)通用標(biāo)記語(yǔ)言下的一個(gè)應(yīng)用）這些現(xiàn)有的廣泛流行的協(xié)議和標(biāo)準(zhǔn)。REST通常使用JSON數(shù)據(jù)格式。
HTTP 方法
以下為REST基本架構(gòu)的四個(gè)方法：GET - 用于獲取數(shù)據(jù)。
PUT - 用于添加數(shù)據(jù)。
DELETE - 用于刪除數(shù)據(jù)。
POST - 用于更新或添加數(shù)據(jù)。
RESTful Web Services
Web service是一個(gè)平臺(tái)獨(dú)立的，低耦合的，自包含的、基于可編程的web的應(yīng)用程序，可使用開(kāi)放的XML（標(biāo)準(zhǔn)通用標(biāo)記語(yǔ)言下的一個(gè)子集）標(biāo)準(zhǔn)來(lái)描述、發(fā)布、發(fā)現(xiàn)、協(xié)調(diào)和配置這些應(yīng)用程序，用于開(kāi)發(fā)分布式的互操作的應(yīng)用程序。
RESTful是基于REST架構(gòu)的Web Services。
由于輕量級(jí)以及通過(guò)HTTP直接傳輸數(shù)據(jù)的特性，Web服務(wù)的RESTful方法已經(jīng)成為最常見(jiàn)的替代方法。可以使用各種語(yǔ)言（比如，Java程序、Perl、Ruby、Python、PHP和Javascript[包括Ajax]）實(shí)現(xiàn)客戶(hù)端。
RESTful Web服務(wù)通常可以通過(guò)自動(dòng)客戶(hù)端或代表用戶(hù)的應(yīng)用程序訪(fǎng)問(wèn)。但是，這種服務(wù)的簡(jiǎn)便性讓用戶(hù)能夠與之直接交互，使用它們的Web瀏覽器構(gòu)建一個(gè)GET URL并讀取返回的內(nèi)容。
更多介紹，可以查看：RESTful 架構(gòu)詳解
創(chuàng)建 RESTful
首先，創(chuàng)建一個(gè)json數(shù)據(jù)資源文件users.json，內(nèi)容如下：
{
"user1" : {
"name" : "mahesh",
"password" : "password1",
"profession" : "teacher",
"id": 1
},
"user2" : {
"name" : "suresh",
"password" : "password2",
"profession" : "librarian",
"id": 2
},
"user3" : {
"name" : "ramesh",
"password" : "password3",
"profession" : "clerk",
"id": 3
}
}
基于以上數(shù)據(jù)，我們創(chuàng)建以下RESTful API：
| 序號(hào) | URI | HTTP 方法 | 發(fā)送內(nèi)容 | 結(jié)果 |
|---|---|---|---|---|
| 1 | listUsers | GET | 空 | 顯示所有用戶(hù)列表 |
| 2 | addUser | POST | JSON 字符串 | 添加新用戶(hù) |
| 3 | deleteUser | DELETE | JSON 字符串 | 刪除用戶(hù) |
| 4 | :id | GET | 空 | 顯示用戶(hù)詳細(xì)信息 |
獲取用戶(hù)列表：
以下代碼，我們創(chuàng)建了RESTful API listUsers，用于讀取用戶(hù)的信息列表， server.js文件代碼如下所示：
var express = require('express');
var app = express();
var fs = require("fs");
app.get('/listUsers', function (req, res) {
fs.readFile( __dirname + "/" + "users.json", 'utf8', function (err, data) {
console.log( data );
res.end( data );
});
})
var server = app.listen(8081, function () {
var host = server.address().address
var port = server.address().port
console.log("應(yīng)用實(shí)例，訪(fǎng)問(wèn)地址為 http://%s:%s", host, port)
})
接下來(lái)執(zhí)行以下命令：
$ node server.js
應(yīng)用實(shí)例，訪(fǎng)問(wèn)地址為 http://0.0.0.0:8081
在瀏覽器中訪(fǎng)問(wèn)http://127.0.0.1:8081/listUsers，結(jié)果如下所示：
{
"user1" : {
"name" : "mahesh",
"password" : "password1",
"profession" : "teacher",
"id": 1
},
"user2" : {
"name" : "suresh",
"password" : "password2",
"profession" : "librarian",
"id": 2
},
"user3" : {
"name" : "ramesh",
"password" : "password3",
"profession" : "clerk",
"id": 3
}
}
添加用戶(hù)
如果要添加新的用戶(hù)數(shù)據(jù)，可以通過(guò)創(chuàng)建RESTful API addUser實(shí)現(xiàn)，server.js文件代碼如下所示：
var express = require('express');
var app = express();
var fs = require("fs");
//添加的新用戶(hù)數(shù)據(jù)
var user = {
"user4" : {
"name" : "mohit",
"password" : "password4",
"profession" : "teacher",
"id": 4
}
}
app.get('/addUser', function (req, res) {
// 讀取已存在的數(shù)據(jù)
fs.readFile( __dirname + "/" + "users.json", 'utf8', function (err, data) {
data = JSON.parse( data );
data["user4"] = user["user4"];
console.log( data );
res.end( JSON.stringify(data));
});
})
var server = app.listen(8081, function () {
var host = server.address().address
var port = server.address().port
console.log("應(yīng)用實(shí)例，訪(fǎng)問(wèn)地址為 http://%s:%s", host, port)
})
接下來(lái)執(zhí)行以下命令：
$ node server.js
應(yīng)用實(shí)例，訪(fǎng)問(wèn)地址為 http://0.0.0.0:8081
在瀏覽器中訪(fǎng)問(wèn)http://127.0.0.1:8081/addUser，結(jié)果如下所示：
{ user1:
{ name: 'mahesh',
password: 'password1',
profession: 'teacher',
id: 1 },
user2:
{ name: 'suresh',
password: 'password2',
profession: 'librarian',
id: 2 },
user3:
{ name: 'ramesh',
password: 'password3',
profession: 'clerk',
id: 3 },
user4:
{ name: 'mohit',
password: 'password4',
profession: 'teacher',
id: 4 }
}
顯示用戶(hù)詳情
以下代碼，我們創(chuàng)建了RESTful API :id（用戶(hù)id）， 用于讀取指定用戶(hù)的詳細(xì)信息，server.js文件代碼如下所示：
var express = require('express');
var app = express();
var fs = require("fs");
app.get('/:id', function (req, res) {
// 首先我們讀取已存在的用戶(hù)
fs.readFile( __dirname + "/" + "users.json", 'utf8', function (err, data) {
data = JSON.parse( data );
var user = data["user" + req.params.id]
console.log( user );
res.end( JSON.stringify(user));
});
})
var server = app.listen(8081, function () {
var host = server.address().address
var port = server.address().port
console.log("應(yīng)用實(shí)例，訪(fǎng)問(wèn)地址為 http://%s:%s", host, port)
})
接下來(lái)執(zhí)行以下命令：
$ node server.js
應(yīng)用實(shí)例，訪(fǎng)問(wèn)地址為 http://0.0.0.0:8081
在瀏覽器中訪(fǎng)問(wèn)http://127.0.0.1:8081/2，結(jié)果如下所示：
{
"name":"suresh",
"password":"password2",
"profession":"librarian",
"id":2
}
刪除用戶(hù)
以下代碼，我們創(chuàng)建了RESTful API deleteUser， 用于刪除指定用戶(hù)的詳細(xì)信息，以下實(shí)例中，用戶(hù)id為2，server.js文件代碼如下所示：
var express = require('express');
var app = express();
var fs = require("fs");
var id = 2;
app.get('/deleteUser', function (req, res) {
// First read existing users.
fs.readFile( __dirname + "/" + "users.json", 'utf8', function (err, data) {
data = JSON.parse( data );
delete data["user" + 2];
console.log( data );
res.end( JSON.stringify(data));
});
})
var server = app.listen(8081, function () {
var host = server.address().address
var port = server.address().port
console.log("應(yīng)用實(shí)例，訪(fǎng)問(wèn)地址為 http://%s:%s", host, port)
})
接下來(lái)執(zhí)行以下命令：
$ node server.js
應(yīng)用實(shí)例，訪(fǎng)問(wèn)地址為 http://0.0.0.0:8081
在瀏覽器中訪(fǎng)問(wèn)http://127.0.0.1:8081/deleteUser，結(jié)果如下所示：
{ user1:
{ name: 'mahesh',
password: 'password1',
profession: 'teacher',
id: 1 },
user3:
{ name: 'ramesh',
password: 'password3',
profession: 'clerk',
id: 3 }
}
更多建議：