第五课：Express框架与RESTful API设计：技术实践与探索

在使用Node.js进行企业应用开发，常用的开发框架Express，其中的中间件、路由配置与参数解析、RESTful API核心技术尤为重要，本文将深入探讨它们在应用开发中的具体使用方法，最后通过Postman来对开发的接口进行测试。

一、Express中间件机制（Middleware）

Express中间件是Express框架的核心特性之一，它允许在请求和响应之间插入处理函数，以实现诸如日志记录、身份验证、数据解析等功能。中间件本质上是一个函数，具有访问请求对象（req）、响应对象（res）以及应用程序请求-响应周期中的下一个中间件函数（通常用next表示）的能力。

中间件的作用
  • 执行日志记录：记录每个请求的详细信息，如请求的URL、方法、时间等。
  • 身份验证和授权：身份验证和用户权限，确保只有经过授权的用户才能访问特定资源。
  • 错误处理：捕获并处理请求处理过程中发生的错误，避免应用程序崩溃。
  • 数据解析：解析请求体中的数据，如JSON、表单数据等。
中间件的使用

在Express中，可以通过app.use()方法注册中间件。中间件可以应用于整个应用程序，也可以应用于特定的路由。例如：

const express = require('express');
const app = express();/** 全局中间件，记录请求日志 */
app.use((req, res, next) => {console.log(`${req.method} ${req.url}`);next();
});/** 路由中间件，解析JSON请求体 */
app.use(express.json());/** 路由处理函数 */
app.post('/user', (req, res) => {console.log(req.body);res.send('User created');
});/** 启动服务器 */
app.listen(3000, () => {console.log('Server is running on port 3000');
});

二、路由配置与参数解析（req.params/req.body）

Express框架提供了灵活的路由配置机制，允许开发者根据不同的请求路径和HTTP方法来定义路由处理函数。在路由处理函数中，可以通过req.params和req.body来解析请求参数。

路由配置

在Express中，路由由请求的方法（如GET、POST）、URL路径和处理函数组成。例如：

/** 定义GET请求接口，获取动态路由的参数并返回数据给接口调用方 */
app.get('/users/:id', (req, res) => {const userId = req.params.id;res.send(`User ID: ${userId}`);
});/** 定义POST请求接口，获取请求体的参数并返回数据给接口调用方 */
app.post('/users', (req, res) => {const user = req.body;res.send(`User created: ${user.name}`);
});
参数解析
  • req.params：用于解析URL路径中的动态参数。例如，在/users/:id路由中，req.params.id将包含URL中的id值。
  • req.body：用于解析请求体中的数据。通常需要使用express.json()或express.urlencoded({ extended: true })中间件来解析JSON或URL编码的表单数据。

三、RESTful API设计规范

RESTful API是一种基于REST架构风格的网络服务接口，它使用HTTP协议的标准方法来实现资源的创建、读取、更新和删除操作（CRUD）。设计RESTful API时，需要遵循以下原则：

  • 使用HTTP方法：GET用于获取资源，POST用于创建资源，PUT用于更新资源，DELETE用于删除资源。
  • 使用名词而非动词：资源URL应使用名词来表示，而不是动词。例如，使用/users而不是/getUser。
  • 使用URI标识资源：每个资源应有一个唯一的URI。
  • 使用状态码表示操作结果：如200表示成功，404表示未找到资源，500表示服务器内部错误。
  • 返回JSON格式的数据：RESTful API通常返回JSON格式的数据，以便客户端解析和处理。
示例

下面是一个简单的RESTful API示例，包含用户资源的增删改查操作：

const express = require('express');
const app = express();
const users = [];
const crypto = require('crypto')/** 获取所有用户 */
app.get('/users', (req, res) => {res.json(users);
});/** 创建新用户 */
app.post('/users', (req, res) => {const newUser = req.body;/** 动态生成用户唯一编码 */const uuid = crypto.randomUUID()let nowUser = {...newUser, id: uuid}users.push(nowUser);res.status(201).json(nowUser);
});/** 获取单个用户 */
app.get('/users/:id', (req, res) => {const user = users.find(u => u.id === req.params.id);if (user) {res.json(user);} else {/** 设置请求状态：404 */res.status(404).send('用户信息不存在');}
});/** 更新用户信息 */
app.put('/users/:id', (req, res) => {const userIndex = users.findIndex(u => u.id === req.params.id);if (userIndex !== -1) {users[userIndex] = { ...users[userIndex], ...req.body };res.json(users[userIndex]);} else {res.status(404).send('用户信息不存在');}
});/** 删除用户 */
app.delete('/users/:id', (req, res) => {const userIndex = users.findIndex(u => u.id === req.params.id);if (userIndex !== -1) {users.splice(userIndex, 1);res.send('User deleted');} else {res.status(404).send('用户信息不存在');}
});/** 设置处理请求体数据为json数据对象，可以设置请求体的数据大小 */
app.use(express.json({limit: '50mb'}));app.listen(3000, () => {console.log('服务器运行在端口：3000');
});

四、使用Postman测试接口

Postman是一款强大的API测试工具，允许开发者发送HTTP请求并查看响应结果。使用Postman可以方便地测试Express框架构建的RESTful API。

测试步骤
  1. 安装并启动Postman：从Postman官网下载并安装Postman应用程序，然后启动它。
  2. 创建新请求：点击Postman左上角的“New”按钮，选择“HTTP Request”来创建一个新的HTTP请求。
  3. 配置请求：
    1. 请求类型：选择GET、POST、PUT或DELETE等HTTP方法。
    2. URL：输入API的端点URL，如http://localhost:3000/users。
    3. 请求头：根据需要添加请求头，如Content-Type: application/json。
    4. 请求体：对于POST和PUT请求，在“Body”选项卡中选择“raw”和“JSON”格式，然后输入请求体数据。
  4. 发送请求：点击“Send”按钮发送请求，并在下方查看响应结果。
测试代码示例

以下是如何使用Postman测试上述RESTful API的示例：

  • 获取所有用户：
    • 请求类型：GET
    • URL：http://localhost:3000/users
    • 响应：JSON格式的用户列表
  • 创建新用户：
    • 请求类型：POST
    • URL：http://localhost:3000/users
    • 请求头：Content-Type: application/json
    • 请求体：{"id": 2, "name": "John Doe"}
    • 响应：JSON格式的新用户信息，状态码201
  • 获取单个用户：
    • 请求类型：GET
    • URL：http://localhost:3000/users/2
    • 响应：JSON格式的用户信息或404错误
  • 更新用户信息：
    • 请求类型：PUT
    • URL：http://localhost:3000/users/2
    • 请求头：Content-Type: application/json
    • 请求体：{"name": "Jane Doe"}
    • 响应：JSON格式的更新后的用户信息
  • 删除用户：
    • 请求类型：DELETE
    • URL：http://localhost:3000/users/2
    • 响应：文本“User deleted”或404错误

通过以上步骤和示例代码，开发者可以方便地使用Postman测试Express框架构建的RESTful API，确保API的功能和性能符合预期。

结论

通过本文，我们深入了解了Node.js的Express框架如何设置开发中间件、接口开发。掌握这些技术将帮助你在Node.js开发中更加高效地进行WebServer应用开发。

关注我！！🫵 持续为你带来Nodejs相关内容。

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.mzph.cn/web/71802.shtml

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

mitmproxy配合Wireshark 抓包分析

mitmproxy配合Wireshark 抓包分析

Mitmproxy 是一款非常强大的 交互式 HTTP 代理 工具，它被广泛应用于 Web 开发、API 调试、安全测试 等领域。与 Wireshark 侧重于被动监听网络流量不同，Mitmproxy 更像一个 主动的中间人，可以拦截、检查、修改和重放 HTTP/HTTPS 流量&#xf…
阅读更多...
Varlens（手机上的单反）Ver.1.9.3 高级版.apk

Varlens（手机上的单反）Ver.1.9.3 高级版.apk

Varlens 是一款专业级手机摄影软件，旨在通过丰富的功能和高自由度参数调节，让手机拍摄效果媲美微单相机。以下是核心功能总结： 一、核心功能 专业拍摄模式 支持手动/自动/程序模式，可调节ISO、快门速度、EV、白平衡等参数27 提供…
阅读更多...
Scala 中的访问修饰符

Scala 中的访问修饰符

在Scala中，面向对象的权限控制主要通过访问修饰符来实现。Scala提供了以下几种访问修饰符来控制类、对象、成员变量和方法的访问权限： 1. 默认访问权限（无修饰符） 如果没有指定任何访问修饰符，成员默认是public的&…
阅读更多...
第十五届蓝桥杯省赛电子类单片机学习过程记录（客观题）

第十五届蓝桥杯省赛电子类单片机学习过程记录（客观题）

客观试题： 01．典型的BUCK电源电路包含哪些关键器件（ABCD） A. 电容 B. 二极管 C. 电感 D. MOSFET 解析： 典型的 BUCK 电源电路是一种降压型的直流-直流转换电路，它包含以下关键器件： A.电容：电容在电路中起到滤波的作用。输入电容用于平滑输入电压的波动，减少电源噪声对…
阅读更多...
Dify使用日常：我是如何按标题级别将word中的内容转存到excel中的

Dify使用日常：我是如何按标题级别将word中的内容转存到excel中的

先上效果图 word中的内容 转存到excel之后 实现步骤： 1、在dify中创建一个工作流，如上图 2、在开始节点增加一个支持文件上传的变量 3、添加文档提取器，提取上传的文件中的内容 4、添加大模型节点，将文档提取器提取出来的内容&…
阅读更多...
Vue 框架深度解析：源码分析与实现原理详解

Vue 框架深度解析：源码分析与实现原理详解

文章目录 一、Vue 核心架构设计1.1 整体架构流程图1.2 模块职责划分 二、响应式系统源码解析2.1 核心类关系图2.2 核心源码分析2.2.1 数据劫持实现2.2.2 依赖收集过程 三、虚拟DOM与Diff算法实现3.1 Diff算法流程图3.2 核心Diff源码 四、模板编译全流程剖析4.1 编译流程图4.2 编…
阅读更多...
IDEA与Maven使用-学习记录（持续补充...）

IDEA与Maven使用-学习记录（持续补充...）

1. 下载与安装 以ideaIU-2021.3.1为例，安装步骤： 以管理员身份启动ideaIU-2021.3.1修改安装路径为：D:\Program Files\JetBrains\IntelliJ IDEA 2021.3.1勾选【创建桌面快捷方式】（可选）、【打开文件夹作为项目】&…
阅读更多...
认识vue2脚手架

认识vue2脚手架

1.认识脚手架结构 使用VSCode将vue项目打开： package.json：包的说明书（包的名字，包的版本，依赖哪些库）。该文件里有webpack的短命令： serve（启动内置服务器） build命令…
阅读更多...
SQL经典查询

SQL经典查询

查询不在表里的数据，一张学生表，一张学生的选课表，要求查出没有选课的学生？ select students.student_name from students left join course_selection on students.student_idcourse_selection.student_id where course_selecti…
阅读更多...
《机器学习数学基础》补充资料：过渡矩阵和坐标变换推导

《机器学习数学基础》补充资料：过渡矩阵和坐标变换推导

尽管《机器学习数学基础》这本书，耗费了比较长的时间和精力，怎奈学识有限，错误难免。因此，除了在专门的网页（ 勘误和修订 ）中发布勘误和修订内容之外，对于重大错误，我还会以专题的形…
阅读更多...
解锁DeepSpeek-R1大模型微调：从训练到部署，打造定制化AI会话系统

解锁DeepSpeek-R1大模型微调：从训练到部署，打造定制化AI会话系统

目录 1. 前言 2.大模型微调概念简述 2.1. 按学习范式分类 2.2. 按参数更新范围分类 2.3. 大模型微调框架简介 3. DeepSpeek R1大模型微调实战 3.1.LLaMA-Factory基础环境安装 3.1大模型下载 3.2. 大模型训练 3.3. 大模型部署 3.4. 微调大模型融合基于SpirngBootVue2…
阅读更多...
第七课：Python反爬攻防战：Headers/IP代理与验证码

第七课：Python反爬攻防战：Headers/IP代理与验证码

在爬虫开发过程中，反爬虫机制成为了我们必须面对的挑战。本文将深入探讨Python爬虫中常见的反爬机制，并详细解析如何通过随机User-Agent生成、代理IP池搭建以及验证码识别来应对这些反爬策略。文章将包含完整的示例代码，帮助读者更好地理解和…
阅读更多...
Vue3——Fragment

Vue3——Fragment

文章目录 一、Fragment的核心意义1. 解决Vue2的单根限制问题2. 减少不必要的 DOM 嵌套3. 语义化和结构化 二、Fragment 的实现原理三、Fragment 使用方式1. 基本用法2. 结合条件渲染3. 动态组件 四、实际应用场景1. 列表/表格组件2. 布局组件3. 语义化标签 五、注意事项1. 属性…
阅读更多...
字节跳动C++客户端开发实习生内推-抖音基础技术

字节跳动C++客户端开发实习生内推-抖音基础技术

智能手机爱好者和使用者，追求良好的用户体验； 具有良好的编程习惯，代码结构清晰，命名规范； 熟练掌握数据结构与算法、计算机网络、操作系统、编译原理等课程； 熟练掌握C/C/OC/Swift一种或多种语言&#xff…
阅读更多...
【Linux学习笔记】Linux基本指令分析和权限的概念

【Linux学习笔记】Linux基本指令分析和权限的概念

【Linux学习笔记】Linux基本指令分析和权限的概念 🔥个人主页：大白的编程日记 🔥专栏：Linux学习笔记 文章目录 【Linux学习笔记】Linux基本指令分析和权限的概念前言一. 指令的分析1.1 alias 指令1.2 grep 指令1.3 zip/unzip 指…
阅读更多...
数据库索引的作用：提升数据检索效率的关键

数据库索引的作用：提升数据检索效率的关键

在数据库管理系统中，数据如同浩瀚海洋中的宝藏，如何快速准确地找到所需信息，成为了一个关键问题。这时候，数据库索引就如同一张精确的航海图，指引着我们高效地定位数据。那么，数据库索引究竟是什么&#xf…
阅读更多...
Lab18_ SQL injection with filter bypass via XML encoding

Lab18_ SQL injection with filter bypass via XML encoding

文章目录 前言：进入实验室构造 payload 前言： 实验室标题为： 通关 XML 编码绕过过滤器的 SQL 注入 简介： 此实验室的库存检查功能中存在 SQL 注入漏洞。查询结果在应用程序的响应中返回，因此您可以使用 UNION 攻击…
阅读更多...
计算机性能指标（计网笔记）

计算机性能指标（计网笔记）

计算机性能指标：速率、带宽、吞吐率、时延、时延带宽积、往返时间RTT、利用率 速率 数据的传输速率，单位bit/s，或kbit/s，Mbit/s，Gbit/s 4*10**10bit/s40Gbit/s 常用带宽单位： 千比每秒kb/s 兆比每秒Mb/s…
阅读更多...
同为科技智能PDU在数据中心场景的应用与解决方案

同为科技智能PDU在数据中心场景的应用与解决方案

数据中心当前处于一个快速发展和技术变革的特殊时期，全新的人工智能应用正在重塑整个世界，为社会带来便捷的同时，也为数据中心的发展带来了新的机遇和挑战。智能算例的爆发式增长，对数据中心提出了大算力、高性能的新需求&#xf…
阅读更多...
蓝桥杯 C++ b组 积木画深度解析

蓝桥杯 C++ b组 积木画深度解析

题目大意：有两种积木块，I型和L型，给定一段2*N的画布，问摆满总共有多少种方式？ 解法：状态压缩dp（强烈建议拿个笔跟着画一下状态，慢慢就懂了） 首先我们规定一下此题解中提…
阅读更多...
最新文章

Copyright @ 2022~2023