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