Node.js RESTful API

发布于 2015-07-05 12:26:14 | 456 次阅读 | 评论: 0 | 来源: 网络整理

什么是REST架构？

REST表示代表性状态传输。REST是一种基于Web标准的架构，并使用HTTP协议。 它都是围绕着资源，其中每一个组件是资源和一个资源是由一个共同的接口使用HTTP的标准方法获得。REST最初是由Roy Fielding在2000年推出。

一个REST服务器只是提供的资源和REST客户端访问和使用HTTP协议修改的资源。这里每个资源由URI标识的/全局标识。其余部分使用各个表示形式表示相同的文字，JSON和XML资源；但JSON是最流行的一种。

HTTP 方法

以下四个HTTP方法通常用在基于REST架构。

• GET - 这是用来提供对资源的只读访问。

• PUT - 这被用来创建新的资源。

• DELETE - 这是用来删除资源。

• POST - 这被用于更新现有资源或者创建新的资源。

RESTful Web服务

Web 服务是用于交换应用程序或系统之间的数据开放的协议和标准的集合。写在各种编程语言和运行在不同平台上的软件应用程序可以使用Web服务来以类似于进程间 通信在单台计算机上的方式通过计算机网络进行交换数据，如因特网。 这种互操作性（如Java和Python，或Windows和Linux应用程序之间的通信）是由于使用开放标准。

基于REST架构的Web服务称为RESTful web服务。这些Web服务使用HTTP方法来实现REST架构的概念。RESTful Web服务通常定义的URI，统一资源标识符一项服务，它提供资源表示，如JSON，并设置HTTP方法。

为一个库创建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。

保持最全的例子部分的硬编码假设的形式，你已经知道如何通过使用Ajax或简单的表单数据，以及如何使用 express Request对象来处理前端的值。

用户列表

让我们用下面的代码在server.js文件中，实现我们的第一个基于RESTful API 的 listUsers：

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("Example app listening at http://%s:%s", host, port)

})

现在尝试使用定义的API，访问 http://127.0.0.1:8081/listUsers 在本地机器上，这将产生以下结果：

可以更改指定的IP地址，当您将投入生产环境的解决方案。

{
   "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
   }
}

添加用户

以下API将告诉你如何在列表中添加新的用户。以下是新用户的详细信息：

user = {
   "user4" : {
      "name" : "mohit",
      "password" : "password4",
      "profession" : "teacher",
      "id": 4
   }
}

您可以接受JSON的使用Ajax调用的形式，但对于视图相同的输入，我们正在这里硬编码。以下是addUser API来在数据库中的新的用户：

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) {
   // First read existing users.
   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("Example app listening at http://%s:%s", host, port)

})

现在尝试使用访问定义的API： 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 } 
}

显示详细信息

现在，我们将执行将使用用户ID被称为API，它会显示相应用户的详细信息。

var express = require('express');
var app = express();
var fs = require("fs");

app.get('/:id', function (req, res) {
   // First read existing users.
   fs.readFile( __dirname + "/" + "users.json", 'utf8', function (err, data) {
       data = JSON.parse( data );
       var user = users["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("Example app listening at http://%s:%s", host, port)

})

现在，让我们把上述服务中使用 http://127.0.0.1:8081/2 在本地计算机上。这将产生以下结果：

{
   "name":"suresh",
   "password":"password2",
   "profession":"librarian",
   "id":2
}

删除用户

这个API是非常相似API addUser，我们接收通过req.body输入数据，然后根据我们从数据库中删除该用户的用户ID。为了让我们的程序简单，我们假设我们要删除ID为2的用户。

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("Example app listening at http://%s:%s", host, port)

})

现在，让我们把上述服务中使用 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 } 
}