# Node.js RESTful API
## 什么是 REST？
RREST即表述性狀態傳遞（英文：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 架構詳解](http://www.runoob.com/w3cnote/restful-architecture.html)
## 創建 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 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/addUsers，結果如下所示：
```
{ 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
```
在瀏覽器中訪問 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 }
}
```
- Node.js 簡介
- Node.js 安裝配置
- Node.js 創建第一個應用
- NPM 使用介紹
- Node.js REPL(交互式解釋器)
- Node.js 回調函數
- Node.js 事件循環
- Node.js EventEmitter
- Node.js Buffer(緩沖區)
- Node.js Stream(流)
- Node.js模塊系統
- Node.js 函數
- Node.js 路由
- Node.js 全局對象
- Node.js 常用工具 util
- Node.js 文件系統
- Node.js GET/POST請求
- Node.js 工具模塊
- Node.js OS 模塊
- Node.js Path 模塊
- Node.js Net 模塊
- Node.js DNS 模塊
- Node.js Domain 模塊
- Node.js Web 模塊
- Node.js Express 框架
- Node.js RESTful API
- Node.js 多進程
- Node.js JXcore 打包
- 免責聲明