node总结之创建并使用RESTful API了解下

REST即表述性状态传递（英文：Representational State Transfer，简称REST）是Roy Fielding博士在2000年他的博士论文中提出来的一种软件架构风格，而这个表述性状态转移是一组架构约束条件和原则。

我们把满足这些约束条件和原则的应用程序或设计叫做RESTful。需要注意的是，REST是设计风格而不是标准，REST通常基于使用HTTP，URI，和XML（标准通用标记语言下的一个子集）以及HTML（标准通用标记语言下的一个应用）这些现有的广泛流行的协议和标准，并且通常使用 JSON 数据格式。

我们来看下REST 基本架构的四个方法：

GET - 用于获取数据。

PUT - 用于更新或添加数据。

DELETE - 用于删除数据。

POST - 用于添加数据。

Web service是一个平台独立的，低耦合的，自包含的、基于可编程的web的应用程序，可使用开放的XML（标准通用标记语言下的一个子集）标准来描述、发布、发现、协调和配置这些应用程序，用于开发分布式的互操作的应用程序，而基于 REST 架构的 Web Services 即是 RESTful。

由于轻量级以及通过 HTTP 直接传输数据的特性，Web 服务的 RESTful 方法已经成为最常见的替代方法。可以使用各种语言（比如 Java 程序、Perl、Ruby、Python、PHP 和 Javascript[包括 Ajax]）实现客户端。

RESTful Web 服务通常可以通过自动客户端或代表用户的应用程序访问。但是，这种服务的简便性让用户能够与之直接交互，使用它们的 Web 浏览器构建一个 GET URL 并读取返回的内容。

咱这里就介绍到这里了，如果想了解更多，请戳这里。

咱们接下来直接看下实例啊，先来创建一个 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) })

运行server文件，并且在浏览器中访问 http://127.0.0.1:8081/listUsers，就可以看到结果。

完事我们再来创建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) })

之后再来创建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) })

之后运行server文件，并在浏览器中访问 http://127.0.0.1:8081/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) })

还有就是这个乱码的问题啊，它除了不是文件读取的编码问题，我们还可以考虑为浏览器自动为没有在 html > head 中解释编码的 html 编码为本地默认编码。我们可以主动添加 head来解决：

res.setHeader('Content-Type', 'text/html; charset=utf8');

还有就是，如果在同一个 server.js 里创建多个 RESTful API ， 并且 :id 放在前边， 那么它会拦截其他的请求，来看下例子：

var id = 2; // 删除用户 app.get('/deleteUser', function (req, res) { // 读取已存在用户 fs.readFile( __dirname + "/" + "user.json", 'utf8', function (err, data) { data = JSON.parse( data ); delete data["user" + id]; console.log( data ); res.end( JSON.stringify(data)); }); }); // 查询用户信息 (放到前边会拦截其他请求) app.get('/:id', function(req, resp){ fs.readFile(__dirname + '/user.json', 'utf-8', function(err, data){ if(err){ console.log(err.stack); return; } data = JSON.parse(data); var user = data['user' + req.params.id]; console.log(user); resp.end(JSON.stringify(user)); } ); });

访问一下，你就会感觉到不同。

好啦，本次记录就到这里了。

如果感觉不错的话，请多多点赞支持哦。。。