Node.js RESTful API
什麼是REST?
REST即表述性狀態傳遞(英文:Representational State Transfer,簡稱REST)是Roy Fielding博士在2000年他的博士論文中提出來的一種軟件架構風格。
表述性狀態轉移是一組架構約束條件和原則。 滿足這些約束條件和原則的應用程序或設計就是RESTful。 需要注意的是,REST是設計風格而不是標準。 REST通常基於使用HTTP,URI,和XML(標准通用標記語言下的一個子集)以及HTML(標准通用標記語言下的一個應用)這些現有的廣泛流行的協議和標準。 REST 通常使用JSON 數據格式。
HTTP 方法
以下為REST 基本架構的四個方法:GET -用於獲取數據。
PUT -用於添加數據。
DELETE -用於刪除數據。
POST -用於更新或添加數據。
RESTful Web Services
Web service是一個平台獨立的,低耦合的,自包含的、基於可編程的web的應用程序,可使用開放的XML(標准通用標記語言下的一個子集)標準來描述、發布、發現、協調和配置這些應用程序,用於開發分佈式的互操作的應用程序。
基於REST 架構的Web Services 即是RESTful。
由於輕量級以及通過HTTP 直接傳輸數據的特性,Web 服務的RESTful 方法已經成為最常見的替代方法。 可以使用各種語言(比如Java 程序、Perl、Ruby、Python、PHP 和Javascript[包括Ajax])實現客戶端。
RESTful Web 服務通常可以通過自動客戶端或代表用戶的應用程序訪問。 但是,這種服務的簡便性讓用戶能夠與之直接交互,使用它們的Web 瀏覽器構建一個GET URL 並讀取返回的內容。
更多介紹,可以查看:RESTful 架構詳解
創建RESTful
首先,創建一個json 數據資源文件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 } }
基於以上數據,我們創建以下RESTful API:
序號 | URI | HTTP 方法 | 發送內容 | 結果 |
---|---|---|---|---|
1 | listUsers | GET | 空 | 顯示所有用戶列表 |
2 | addUser | POST | JSON 字符串 | 添加新用戶 |
3 | deleteUser | DELETE | JSON 字符串 | 刪除用戶 |
4 | :id | GET | 空 | 顯示用戶詳細信息 |
獲取用戶列表:
以下代碼,我們創建了RESTful APIlistUsers ,用於讀取用戶的信息列表, 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) })
接下來執行以下命令:
$ 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 } }
添加用戶
以下代碼,我們創建了RESTful APIaddUser ,用於添加新的用戶數據,server.js文件代碼如下所示:
var express = require('express'); var app = express(); var fs = require("fs"); //添加的新用户数据 var user = { "user4" : { "name" : "mohit", "password" : "password4", "profession" : "teacher", "id": 4 } } app.get('/addUser', function (req, res) { // 读取已存在的数据 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) })
接下來執行以下命令:
$ 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 } }
顯示用戶詳情
以下代碼,我們創建了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) })
接下來執行以下命令:
$ node server.js 应用实例,访问地址为 http://0.0.0.0:8081
在瀏覽器中訪問http://127.0.0.1:8081/2,結果如下所示:
{ "name":"suresh", "password":"password2", "profession":"librarian", "id":2 }
刪除用戶
以下代碼,我們創建了RESTful APIdeleteUser ,用於刪除指定用戶的詳細信息,以下實例中,用戶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) })
接下來執行以下命令:
$ 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 } }