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 } 

}

目录
相关文章
|
6月前
|
XML JSON API
识别这些API接口定义(http,https,api,RPC,webservice,Restful api ,OpenAPI)
本内容介绍了API相关的术语分类,包括传输协议(HTTP/HTTPS)、接口风格(RESTful、WebService、RPC)及开放程度(API、OpenAPI),帮助理解各类API的特点与应用场景。
|
8月前
|
缓存 安全 API
RESTful与GraphQL:电商API接口设计的技术细节与适用场景
本文对比了RESTful与GraphQL这两种主流电商API接口设计方案。RESTful通过资源与HTTP方法定义操作,简单直观但可能引发过度或欠获取数据问题;GraphQL允许客户端精确指定所需字段,提高灵活性和传输效率,但面临深度查询攻击等安全挑战。从性能、灵活性、安全性及适用场景多维度分析,RESTful适合资源导向场景,GraphQL则适用于复杂数据需求。实际开发中需根据业务特点选择合适方案,或结合两者优势,以优化用户体验与系统性能。
|
8月前
|
JSON 编解码 API
Go语言网络编程:使用 net/http 构建 RESTful API
本章介绍如何使用 Go 语言的 `net/http` 标准库构建 RESTful API。内容涵盖 RESTful API 的基本概念及规范,包括 GET、POST、PUT 和 DELETE 方法的实现。通过定义用户数据结构和模拟数据库,逐步实现获取用户列表、创建用户、更新用户、删除用户的 HTTP 路由处理函数。同时提供辅助函数用于路径参数解析,并展示如何设置路由器启动服务。最后通过 curl 或 Postman 测试接口功能。章节总结了路由分发、JSON 编解码、方法区分、并发安全管理和路径参数解析等关键点,为更复杂需求推荐第三方框架如 Gin、Echo 和 Chi。
|
7月前
|
缓存 边缘计算 前端开发
从业务需求到技术栈:电商API选型RESTful还是GraphQL?这5个维度帮你决策
在数字经济时代,电商平台的竞争已延伸至用户体验与系统效能。作为连接前后端及各类服务的核心,API接口的架构设计至关重要。本文对比RESTful与GraphQL两大主流方案,从电商场景出发,分析两者的技术特性、适用场景与选型逻辑,帮助开发者根据业务需求做出最优选择。
|
10月前
|
前端开发 JavaScript NoSQL
使用 Node.js、Express 和 React 构建强大的 API
本文详细介绍如何使用 Node.js、Express 和 React 构建强大且动态的 API。从开发环境搭建到集成 React 前端,再到利用 APIPost 高效测试 API,适合各水平开发者。内容涵盖 Node.js 运行时、Express 框架与 React 库的基础知识及协同工作方式,还涉及数据库连接和前后端数据交互。通过实际代码示例,助你快速上手并优化应用性能。
|
11月前
|
Kubernetes API 网络安全
当node节点kubectl 命令无法连接到 Kubernetes API 服务器
当Node节点上的 `kubectl`无法连接到Kubernetes API服务器时,可以通过以上步骤逐步排查和解决问题。首先确保网络连接正常,验证 `kubeconfig`文件配置正确,检查API服务器和Node节点的状态,最后排除防火墙或网络策略的干扰,并通过重启服务恢复正常连接。通过这些措施,可以有效解决与Kubernetes API服务器通信的常见问题,从而保障集群的正常运行。
909 17
|
11月前
|
机器学习/深度学习 设计模式 API
Python 高级编程与实战:构建 RESTful API
本文深入探讨了使用 Python 构建 RESTful API 的方法,涵盖 Flask、Django REST Framework 和 FastAPI 三个主流框架。通过实战项目示例,详细讲解了如何处理 GET、POST 请求,并返回相应数据。学习这些技术将帮助你掌握构建高效、可靠的 Web API。
|
11月前
|
JavaScript 前端开发 API
JavaScript中通过array.map()实现数据转换、创建派生数组、异步数据流处理、复杂API请求、DOM操作、搜索和过滤等,array.map()的使用详解(附实际应用代码)
array.map()可以用来数据转换、创建派生数组、应用函数、链式调用、异步数据流处理、复杂API请求梳理、提供DOM操作、用来搜索和过滤等,比for好用太多了,主要是写法简单,并且非常直观,并且能提升代码的可读性,也就提升了Long Term代码的可维护性。 只有锻炼思维才能可持续地解决问题,只有思维才是真正值得学习和分享的核心要素。如果这篇博客能给您带来一点帮助,麻烦您点个赞支持一下,还可以收藏起来以备不时之需,有疑问和错误欢迎在评论区指出~
|
JavaScript 前端开发 安全
盘点原生JS中目前最没用的几个功能API
在JavaScript的发展历程中,许多功能与API曾风光无限,但随着技术进步和语言演化,部分功能逐渐被淘汰或被更高效的替代方案取代。例如,`with`语句使代码作用域复杂、可读性差;`void`操作符功能冗余且影响可读性;`eval`函数存在严重安全风险和性能问题;`unescape`和`escape`函数已被`decodeURIComponent`和`encodeURIComponent`取代;`arguments`对象则被ES6的剩余参数语法替代。这些变化体现了JavaScript不断优化的趋势,开发者应紧跟技术步伐,学习新技能,适应新技术环境。
256 10
|
JSON JavaScript 前端开发
深入浅出Node.js:从零开始构建RESTful API
在数字化时代的浪潮中,后端开发作为连接用户与数据的桥梁,扮演着至关重要的角色。本文将引导您步入Node.js的奇妙世界,通过实践操作,掌握如何使用这一强大的JavaScript运行时环境构建高效、可扩展的RESTful API。我们将一同探索Express框架的使用,学习如何设计API端点,处理数据请求,并实现身份验证机制,最终部署我们的成果到云服务器上。无论您是初学者还是有一定基础的开发者,这篇文章都将为您打开一扇通往后端开发深层知识的大门。
343 12