天天看點
傳回

49.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 發送内容 結果
1 listUsers GET 空 顯示所有使用者清單
2 addUser POST JSON 字元串 添加新使用者
3 deleteUser DELETE 删除使用者
4 :id 顯示使用者詳細資訊

擷取使用者清單：

以下代碼，我們建立了 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 = 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 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)

})      
$ node server.js 
應用執行個體，通路位址為 http://0.0.0.0:8081      
{ user1:
   { name: 'mahesh',
     password: 'password1',
     profession: 'teacher',
     id: 1 },
  user3:
   { name: 'ramesh',
     password: 'password3',
     profession: 'clerk',
     id: 3 } 
}
json 應用執行個體 資料 應用程式 d3
上一篇: UML中部署圖
下一篇: 雷林鵬分享Node.js RESTful API

繼續閱讀