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 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

#p#分页标题#e#

在欣赏器中会见 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

在欣赏器中会见 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 } 
}

什么是 REST？

HTTP 要领

RESTful Web Services

建设 RESTful

获取用户列表：

添加用户

显示用户详情

删除用户

关键字：