Node.js RESTful API

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:

序號URIHTTP 方法傳送內容結果
1listUsersGET顯示所有使用者列表
2addUserPOSTJSON 字串新增新使用者
3deleteUserDELETEJSON 字串刪除使用者
4:idGET顯示使用者詳細資訊

獲取使用者列表:

以下程式碼,我們建立了 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)

})

接下來執行以下命令:

$ 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 API addUser, 用於新增新的使用者資料,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 = https://www.itread01.com/nodejs/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 = https://www.itread01.com/nodejs/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 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 = https://www.itread01.com/nodejs/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("應用例項,訪問地址為 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 } 
}