Node.js RESTful API

简介: 10月更文挑战第8天

什么是 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" + id];

     

      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 } 

}

目录
相关文章
|
15天前
|
JSON 缓存 JavaScript
深入浅出:使用Node.js构建RESTful API
在这个数字时代,API已成为软件开发的基石之一。本文旨在引导初学者通过Node.js和Express框架快速搭建一个功能完备的RESTful API。我们将从零开始,逐步深入,不仅涉及代码编写,还包括设计原则、最佳实践及调试技巧。无论你是初探后端开发,还是希望扩展你的技术栈,这篇文章都将是你的理想指南。
|
8天前
|
JSON JavaScript 前端开发
深入浅出Node.js:从零开始构建RESTful API
在数字化时代的浪潮中,后端开发作为连接用户与数据的桥梁,扮演着至关重要的角色。本文将引导您步入Node.js的奇妙世界,通过实践操作,掌握如何使用这一强大的JavaScript运行时环境构建高效、可扩展的RESTful API。我们将一同探索Express框架的使用,学习如何设计API端点,处理数据请求,并实现身份验证机制,最终部署我们的成果到云服务器上。无论您是初学者还是有一定基础的开发者,这篇文章都将为您打开一扇通往后端开发深层知识的大门。
26 12
|
15天前
|
JavaScript NoSQL API
深入浅出Node.js:从零开始构建RESTful API
在数字化时代的浪潮中,后端开发如同一座灯塔,指引着数据的海洋。本文将带你航行在Node.js的海域,探索如何从一张白纸到完成一个功能完备的RESTful API。我们将一起学习如何搭建开发环境、设计API结构、处理数据请求与响应,以及实现数据库交互。准备好了吗?启航吧!
|
18天前
|
JSON 关系型数据库 测试技术
使用Python和Flask构建RESTful API服务
使用Python和Flask构建RESTful API服务
|
23天前
|
JSON JavaScript API
深入浅出Node.js:从零开始构建RESTful API
【10月更文挑战第39天】 在数字化时代的浪潮中,API(应用程序编程接口)已成为连接不同软件应用的桥梁。本文将带领读者从零基础出发,逐步深入Node.js的世界,最终实现一个功能完备的RESTful API。通过实践,我们将探索如何利用Node.js的异步特性和强大的生态系统来构建高效、可扩展的服务。准备好迎接代码和概念的碰撞,一起解锁后端开发的新篇章。
|
19天前
|
JSON JavaScript 前端开发
使用JavaScript和Node.js构建简单的RESTful API
使用JavaScript和Node.js构建简单的RESTful API
|
24天前
|
JSON API 数据格式
淘宝 / 天猫官方商品 / 订单订单 API 接口丨商品上传接口对接步骤
要对接淘宝/天猫官方商品或订单API,需先注册淘宝开放平台账号,创建应用获取App Key和App Secret。之后,详细阅读API文档,了解接口功能及权限要求,编写认证、构建请求、发送请求和处理响应的代码。最后,在沙箱环境中测试与调试,确保API调用的正确性和稳定性。
|
1月前
|
供应链 数据挖掘 API
电商API接口介绍——sku接口概述
商品SKU(Stock Keeping Unit)接口是电商API接口中的一种,专门用于获取商品的SKU信息。SKU是库存量单位,用于区分同一商品的不同规格、颜色、尺寸等属性。通过商品SKU接口,开发者可以获取商品的SKU列表、SKU属性、库存数量等详细信息。
|
1月前
|
JSON API 数据格式
店铺所有商品列表接口json数据格式示例(API接口)
当然,以下是一个示例的JSON数据格式,用于表示一个店铺所有商品列表的API接口响应
|
2月前
|
编解码 监控 API
直播源怎么调用api接口
调用直播源的API接口涉及开通服务、添加域名、获取API密钥、调用API接口、生成推流和拉流地址、配置直播源、开始直播、监控管理及停止直播等步骤。不同云服务平台的具体操作略有差异,但整体流程简单易懂。