夜鹰教程网-程序员的加油站
 当前位置:文章中心 >> NodeJs视频教程
Node.js RESTful API
夜鹰教程网 来源:www.yyjcw.com 日期:2018-6-2 18:52:58
什么是 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

在浏览器中访问 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 } 

}


复制链接 网友评论 收藏本文 关闭此页
上一条: Node.js 多进程详解  下一条: Node.js Express 框架 文件上传等
夜鹰教程网成立于2008年,目前已经运营了将近 13 年,发布了大量关于 html5/css3/C#/asp.net/java/python/nodejs/mongodb/sql server/android/javascript/mysql/mvc/easyui/vue/echarts原创教程。 我们一直都在坚持的是:认证负责、一丝不苟、以工匠的精神来打磨每一套教程,让读者感受到作者的用心。我们默默投入的时间,确保每一套教程都是一件作品,而不是呆板的文字和视频! 目前我们推出在线辅导班试运营,模式为一对一辅导,教学工具为QQ。我们的辅导学科包括 java 、android原生开发、webapp开发、商城开发、C#和asp.net开发,winform和物联网开发、web前端开发,但不仅限于此。 普通班针对的是国内学员,例如想打好基础的大学生、想转行的有志青年、想深入学习的程序员、想开发软件的初学者或者业余爱好者等。 就业办针对即将毕业上岗的大四学生,或者打算转行的初级开发工程师。 留学生班针对的是在欧美、加拿大、澳洲、日本、韩国、新加坡等地留学的中国学子,目的是让大家熟练地掌握编程技能,按时完成老师布置的作业,并能顺利地通过考试。 详细咨询QQ:1416759661   夜鹰教程网  基于角色的权限管理系统(c-s/b-s)。
  夜鹰教程网  基于nodejs的聊天室开发视频教程
  夜鹰教程网  Git分布式版本管理视频教程
  夜鹰教程网  MVC+EasyUI视频教程
  夜鹰教程网  在线考试系统视频教程
  夜鹰教程网  MongoDB视频教程。
  夜鹰教程网 Canvas视频教程
  夜鹰教程网 报表开发视频教程
  热点推荐
在Windows系统下搭建SVN服务器
宽带连接速度慢
在iis下设置伪静态的规则和方法
Oralce 9i安装OID目录服务器说明
需要停止的windows 2003 server服…
.htaccess文件设置技巧16则
Apache SSL证书安装指南
linux下手工修改分区后的挂载
MSN服务器为什么不放置在中国境内…
自定义MIME类型 网络空间支持FLV
稳定的国外网站服务器对SEO排名没…
Windows下定期自动备份网站软件—…
实战讲解:从零开始配置Linux服务器…
IIS错误代码及其含义
服务器领域众“菜鸟”们的几个常见…
  最近更新
nodejs文件上传代码
nodejs如何设置允许跨域请求
npm 项目更换目录后无法启动
Git常用命令学习
Node.js 连接 MongoDB
Node.js JXcore 打包
Node.js 多进程详解
Node.js RESTful API
Node.js Express 框架 文件上传等…
Node.js Web 模块
Node.js 工具模块
Node.js GET/POST请求
Node.js 文件系统
Node.js 常用工具函数
Node.js 全局对象

关于我们 | 网站建设 | 技术辅导 | 常见问题 | 联系我们 | 友情链接

夜鹰教程网 版权所有 www.yyjcw.com All rights reserved 备案号:蜀ICP备08011740号3