第五课：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相关内容。

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

如若内容造成侵权/违法违规/事实不符，请联系我们进行投诉反馈qq邮箱809451989@qq.com，一经查实，立即删除！

相关文章

基于Django的协同过滤算法养老新闻推荐系统的设计与实现

基于Django的协同过滤算法养老新闻推荐系统的设计与实现

基于Django的协同过滤算法养老新闻推荐系统（可改成普通新闻推荐系统使用） 开发工具和实现技术 Pycharm，Python，Django框架，mysql8，navicat数据库管理工具，vue，spider爬虫&#xff0…
阅读更多...
Facebook 的隐私保护数据存储方案研究

Facebook 的隐私保护数据存储方案研究

Facebook 的隐私保护数据存储方案研究 在这个信息爆炸的时代，数据隐私保护已成为公众关注的热点。Facebook，作为全球最大的社交媒体平台之一，承载着海量用户数据，其隐私保护措施和数据存储方案对于维护用户隐私至关重要。本文将深…
阅读更多...
World of Warcraft [CLASSIC] BigFoot BiaoGe

World of Warcraft [CLASSIC] BigFoot BiaoGe

World of Warcraft [CLASSIC] BigFoot BiaoGe 金团表格插件 设置60秒拍卖装备时间 ALT 鼠标左键，点击装备，弹出对话框，填写 1）拍卖时间默认60秒，起拍价， 2）点击【开始拍卖】 团队所有安装了…
阅读更多...
Docker和DockerCompose基础教程及安装教程

Docker和DockerCompose基础教程及安装教程

Docker的应用场景 Web 应用的自动化打包和发布。自动化测试和持续集成、发布。在服务型环境中部署和调整数据库或其他的后台应用。从头编译或者扩展现有的 OpenShift 或 Cloud Foundry 平台来搭建自己的 PaaS 环境。 CentOS Docker 安装 使用官方安装脚本自动安装 安装命令…
阅读更多...
题解：洛谷 AT_dp_c Vacation

题解：洛谷 AT_dp_c Vacation

题目https://www.luogu.com.cn/problem/AT_dp_c设 表示对于前 天&#xff0c;以 项目结尾能获得的最大价值。 则&#xff1a; 答案为&#xff1a;。 实现 #include<bits/stdc.h> using namespace std; #define int long long int n,dp[100005][3]; signed main(){i…
阅读更多...
通义万相2.1：开启视频生成新时代

通义万相2.1：开启视频生成新时代

文章摘要&#xff1a;通义万相 2.1 是一款在人工智能视频生成领域具有里程碑意义的工具&#xff0c;它通过核心技术的升级和创新&#xff0c;为创作者提供了更强大、更智能的创作能力。本文详细介绍了通义万相 2.1 的背景、核心技术、功能特性、性能评测、用户反馈以及应用场景…
阅读更多...
ubuntu 20.04 C++ 源码编译 cuda版本 opencv4.5.0

ubuntu 20.04 C++ 源码编译 cuda版本 opencv4.5.0

前提条件是安装好了cuda和cudnn 点击下载&#xff1a; opencv_contrib4.5.0 opencv 4.5.0 解压重命名后 进入opencv目录&#xff0c;创建build目录 “CUDA_ARCH_BIN ?” 这里要根据显卡查询一下,我的cuda是11&#xff0c;显卡1650&#xff0c;所以是7.5 查询方法1&#xff1…
阅读更多...
【人工智能】Open WebUI+ollama+deepSeek-r1 本地部署大模型与知识库

【人工智能】Open WebUI+ollama+deepSeek-r1 本地部署大模型与知识库

目录 一 、命令行下载安装 二、运行 三、添加开机自启服务 ollama serve 四、重新加载配置、重启ollama server 五、查看模型文件信息 六、 添加open-webui 七、 配置open webui 八、创建自己知识库 九、网络加密优化 十、大工告成&#xff0c;大家如果有问题可以私信…
阅读更多...
DeepSeek R1-7B 医疗大模型微调实战全流程分析（全码版）

DeepSeek R1-7B 医疗大模型微调实战全流程分析（全码版）

DeepSeek R1-7B 医疗大模型微调实战全流程指南 目录 环境配置与硬件优化医疗数据工程微调策略详解训练监控与评估模型部署与安全持续优化与迭代多模态扩展伦理与合规体系故障排除与调试行业应用案例进阶调优技巧版本管理与迭代法律风险规避成本控制方案文档与知识传承1. 环境配…
阅读更多...
Android Studio右上角Gradle 的Task展示不全

Android Studio右上角Gradle 的Task展示不全

Android Studio 版本如下&#xff1a;Android Studio lguana|2023.21, 发现Gradle 的Tasks阉割严重&#xff0c;如下图&#xff0c;只显示一个other 解决方法如下&#xff1a;**Setting>Experimental>勾选Configure all gradle tasks during Gradle Sync(this can make…
阅读更多...
[HTTP协议]应用层协议HTTP从入门到深刻理解并落地部署自己的云服务(2)

[HTTP协议]应用层协议HTTP从入门到深刻理解并落地部署自己的云服务(2)

标题&#xff1a;[HTTP协议]应用层协议HTTP从入门到深刻理解并落地部署自己的云服务(2) 水墨不写bug 文章目录 一、无法拷贝类(class uncopyable)的设计解释&#xff1a;重要思想&#xff1a;使用示例 二、锁的RAII设计解释重要考虑使用示例 三、基于RAII模式和互斥锁的的日志…
阅读更多...
YOLOv8改进SPFF-LSKA大核可分离核注意力机制

YOLOv8改进SPFF-LSKA大核可分离核注意力机制

YOLOv8改进------------SPFF-LSKA 1、LSAK.py代码2、添加YAML文件yolov8_SPPF_LSKA.yaml3、添加SPPF_LSKA代码4、ultralytics/nn/modules/__init__.py注册模块5、ultralytics/nn/tasks.py注册模块6、导入yaml文件训练 1、LSAK.py代码 论文 代码 LSKA.py添加到ultralytics/nn/…
阅读更多...
系统架构设计师—系统架构设计篇—特定领域软件体系结构

系统架构设计师—系统架构设计篇—特定领域软件体系结构

文章目录 概述领域分类垂直域水平域 系统模型基本活动参与角色 概述 特定领域软件架构&#xff08;Domain Specific Software Architecture&#xff0c;DSSA&#xff09;是在一个特定应用领域中&#xff0c;为一组应用提供组织结构参考的标准团建体系结构。 领域分类 垂直域…
阅读更多...
第四次CCF-CSP认证（含C++源码）

第四次CCF-CSP认证（含C++源码）

第四次CCF-CSP认证 第一道&#xff08;easy&#xff09;思路及AC代码 第二道&#xff08;easy&#xff09;思路及AC代码遇到的问题 第三道&#xff08;mid&#xff09;思路及AC代码 第一道&#xff08;easy&#xff09; 题目链接 思路及AC代码 这题就是将这个矩阵旋转之后输出…
阅读更多...
软考中级-数据库-3.3 数据结构-树

软考中级-数据库-3.3 数据结构-树

定义:树是n(n>=0)个结点的有限集合。当n=0时称为空树。在任一非空树中，有且仅有一个称为根的结点:其余结点可分为m(m>=0)个互不相交的有限集T1,T2,T3...,Tm…，其中每个集合又都是一棵树，并且称为根结点的子树。 树的相关概念 1、双亲、孩子和兄弟: 2、结点的度:一个结…
阅读更多...
Django小白级开发入门

Django小白级开发入门

1、Django概述 Django是一个开放源代码的Web应用框架&#xff0c;由Python写成。采用了MTV的框架模式&#xff0c;即模型M&#xff0c;视图V和模版T。 Django 框架的核心组件有&#xff1a; 用于创建模型的对象关系映射为最终用户设计较好的管理界面URL 设计设计者友好的模板…
阅读更多...
【爬虫】开篇词

【爬虫】开篇词

一、网络爬虫概述 二、网络爬虫的应用场景 三、爬虫的痛点 四、需要掌握哪些技术&#xff1f; 在这个信息爆炸的时代&#xff0c;如何高效地获取和处理海量数据成为一项核心技能。无论是数据分析、商业情报、学术研究&#xff0c;还是人工智能训练&#xff0c;网络爬虫&…
阅读更多...
C语言 —— 愿此世如黄金般辉煌 - 进制转换与操作符详解

C语言 —— 愿此世如黄金般辉煌 - 进制转换与操作符详解

目录 1. 操作符的分类 2. ⼆进制和进制转换 2.1 2进制转10进制 2.2 10进制转2进制 2.3 2进制转8进制 2.4 2进制转16进制 3. 原码、反码、补码 4. 移位操作符 4.1 左移操作符 4.2 右移操作符 5. 位操作符&#xff1a;&、|、^、~ 5.1 & 按位与 5.2 | 按位或 …
阅读更多...
VsCode导入时选择相对路径

VsCode导入时选择相对路径

自动导入时总是以db://开头了&#xff0c;而我们通常需要的是相对路径&#xff0c;对VsCode进行如下设置&#xff1a; 打开 VSCode 设置&#xff1a; 使用快捷键 Ctrl ,&#xff08;Windows/Linux&#xff09;或 Cmd ,&#xff08;Mac&#xff09;。 或者在菜单栏中选择 …
阅读更多...
Python3 爬虫 爬虫中间件

Python3 爬虫 爬虫中间件

爬虫中间件的用法与下载器中间件非常相似&#xff0c;只是它们的作用对象不同。下载器中间件的作用对象是请求request和返回response&#xff1b;爬虫中间键的作用对象是爬虫&#xff0c;更具体地来说&#xff0c;就是写在spiders文件夹下面的各个文件。它们的关系&#xff0c;…
阅读更多...
最新文章

Copyright @ 2022~2023