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 } 

}

目录
相关文章
|
1月前
|
JSON JavaScript 前端开发
深入浅出Node.js:从零开始构建RESTful API
在数字化时代的浪潮中,后端开发作为连接用户与数据的桥梁,扮演着至关重要的角色。本文将引导您步入Node.js的奇妙世界,通过实践操作,掌握如何使用这一强大的JavaScript运行时环境构建高效、可扩展的RESTful API。我们将一同探索Express框架的使用,学习如何设计API端点,处理数据请求,并实现身份验证机制,最终部署我们的成果到云服务器上。无论您是初学者还是有一定基础的开发者,这篇文章都将为您打开一扇通往后端开发深层知识的大门。
52 12
|
2月前
|
XML JSON 缓存
深入理解RESTful API设计原则与实践
在现代软件开发中,构建高效、可扩展的应用程序接口(API)是至关重要的。本文旨在探讨RESTful API的核心设计理念,包括其基于HTTP协议的特性,以及如何在实际应用中遵循这些原则来优化API设计。我们将通过具体示例和最佳实践,展示如何创建易于理解、维护且性能优良的RESTful服务,从而提升前后端分离架构下的开发效率和用户体验。
|
2月前
|
JSON 缓存 测试技术
构建高效RESTful API的后端实践指南####
本文将深入探讨如何设计并实现一个高效、可扩展且易于维护的RESTful API。不同于传统的摘要概述,本节将直接以行动指南的形式,列出构建RESTful API时必须遵循的核心原则与最佳实践,旨在为开发者提供一套直接可行的实施框架,快速提升API设计与开发能力。 ####
|
2月前
|
JSON API 开发者
深入理解RESTful API设计原则
在数字化时代,API已成为连接不同软件应用的桥梁。本文旨在探讨RESTful API设计的基本原则和最佳实践,帮助开发者构建高效、可扩展的网络服务接口。通过解析REST架构风格的核心概念,我们将了解如何设计易于理解和使用的API,同时保证其性能和安全性。
|
2月前
|
存储 缓存 API
深入理解RESTful API设计原则
在现代软件开发中,RESTful API已成为前后端分离架构下不可或缺的通信桥梁。本文旨在探讨RESTful API的核心设计原则,包括资源导向、无状态、统一接口、以及可缓存性等,并通过实例解析如何在实际应用中遵循这些原则来构建高效、可维护的API接口。我们将深入分析每个原则背后的设计理念,提供最佳实践指导,帮助开发者优化API设计,提升系统整体性能和用户体验。
40 0
|
2月前
|
安全 测试技术 API
构建高效RESTful API:后端开发的艺术与实践####
在现代软件开发的浩瀚星空中,RESTful API如同一座桥梁,连接着前端世界的绚丽多彩与后端逻辑的深邃复杂。本文旨在探讨如何精心打造一款既高效又易于维护的RESTful API,通过深入浅出的方式,剖析其设计原则、实现技巧及最佳实践,为后端开发者提供一份实用的指南。我们不深入晦涩的理论,只聚焦于那些能够即刻提升API品质与开发效率的关键点,让你的API在众多服务中脱颖而出。 ####
38 0
|
12天前
|
JavaScript
nodejs安装之npm ERR! code CERT_HAS_EXPIREDnpm ERR! errno CERT_HAS_EXPIRED reason: certificate has expired-证书错误通用问题解决方案-优雅草央千澈
nodejs安装之npm ERR! code CERT_HAS_EXPIREDnpm ERR! errno CERT_HAS_EXPIRED reason: certificate has expired-证书错误通用问题解决方案-优雅草央千澈
|
2月前
|
Web App开发 JavaScript 前端开发
2024年5月node.js安装(winmac系统)保姆级教程
本篇博客为2024年5月版Node.js安装教程,适用于Windows和Mac系统。作者是一名熟悉JavaScript与Vue的大一学生,分享了Node.js的基本介绍、下载链接及简单安装步骤。安装完成后,通过终端命令`node -v`验证版本即可确认安装成功。欢迎关注作者,获取更多技术文章。
39 2
2024年5月node.js安装(winmac系统)保姆级教程
|
2月前
|
存储 JavaScript 搜索推荐
Node框架的安装和配置方法
安装 Node 框架是进行 Node 开发的第一步,通过正确的安装和配置,可以为后续的开发工作提供良好的基础。在安装过程中,需要仔细阅读相关文档和提示,遇到问题及时解决,以确保安装顺利完成。
143 2
|
4月前
|
JavaScript
NodeJs的安装
文章介绍了Node.js的安装步骤和如何创建第一个Node.js应用。包括从官网下载安装包、安装过程、验证安装是否成功,以及使用Node.js监听端口构建简单服务器的示例代码。
NodeJs的安装