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