【Node.js从基础到高级运用】十一、构建RESTful API

在本篇博客中,我们将综合之前讨论的内容,深入探索如何使用Node.js构建一个RESTful API。我们将重点讨论设计合理的API端点,展示如何通过代码实现这些端点,并指导如何使用Postman测试我们的API,确保其按预期工作。

前提条件

  • Node.js和npm已安装
  • 基本的JavaScript知识
  • 理解REST原则
  • 安装Postman以测试API

步骤1:项目初始化与Express安装

首先,创建项目目录并初始化Node.js项目:

mkdir my-rest-api
cd my-rest-api
npm init -y

安装Express框架:

npm install express -D

步骤2:设计合理的API端点

合理设计API端点是创建RESTful服务的关键。端点应该清晰、直观且专注于资源,同时使用适当的HTTP方法表示操作。

实例端点设计:

获取所有书籍: GET /books
获取单本书籍: GET /books/:id
添加书籍: POST /books
更新书籍: PUT /books/:id
删除书籍: DELETE /books/:id

步骤3:实现API端点

在你的项目中创建一个index.js文件,并开始编写代码来实现这些API端点。让我们扩展我们的API,以支持CRUD操作。

定义一些假数据作为数据库

let books = [{ id: 1, title: 'JavaScript高级程序设计', author: 'Nicholas C. Zakas' },{ id: 2, title: 'Node.js实战', author: 'Mike Cantelon, Marc Harter, T.J. Holowaychuk, Nathan Rajlich' },// 添加更多书籍...
];

添加路由

// 获取所有书籍
app.get('/books', (req, res) => {res.json(books);
});// 通过ID获取单本书
app.get('/books/:id', (req, res) => {const book = books.find(b => b.id === parseInt(req.params.id));if (!book) res.status(404).send('找不到该书籍');res.json(book);
});// 添加一本书(示例未包括实际数据接收和验证逻辑)
app.post('/books', (req, res) => {// 添加书籍到books数组// 发送回新增书籍的JSON
});// 更新书籍(示例未包括实际数据更新逻辑)
app.put('/books/:id', (req, res) => {// 查找并更新书籍信息// 发送回更新后的书籍JSON
});// 删除书籍
app.delete('/books/:id', (req, res) => {books = books.filter(b => b.id !== parseInt(req.params.id));res.send('书籍已删除');
});

使用Body-Parser处理POST和PUT请求

要处理JSON格式的请求体数据,我们需要安装并使用body-parser中间件:

npm install body-parser -D

然后,在你的index.js文件中添加以下代码来引入并使用body-parser

const bodyParser = require('body-parser');// 使用body-parser中间件
app.use(bodyParser.json());

这允许你通过req.body访问POST和PUT请求中的JSON数据。

完整示例

const express = require('express');
const bodyParser = require('body-parser');const app = express();
const port = 3000;let books = [{ id: 1, title: 'JavaScript高级程序设计', author: 'Nicholas C. Zakas' },{ id: 2, title: 'Node.js实战', author: 'Mike Cantelon, Marc Harter, T.J. Holowaychuk, Nathan Rajlich' },
];app.use(bodyParser.json());app.get('/books', (req, res) => {res.status(200).json(books);
});app.get('/books/:id', (req, res) => {const book = books.find(b => b.id === parseInt(req.params.id));if (!book) return res.status(404).send('书籍未找到');res.status(200).json(book);
});app.post('/books', (req, res) => {const book = {id: books.length + 1,title: req.body.title,author: req.body.author,};books.push(book);res.status(201).send(book);
});app.put('/books/:id', (req, res) => {let book = books.find(b => b.id === parseInt(req.params.id));if (!book) return res.status(404).send('书籍未找到');book.title = req.body.title || book.title;book.author = req.body.author || book.author;res.status(200).send(book);
});app.delete('/books/:id', (req, res) => {books = books.filter(b => b.id !== parseInt(req.params.id));res.status(204).send();
});app.listen(port, () => {console.log(`服务器运行在 http://localhost:${port}`);
});

步骤4:使用Postman测试API

测试是确保我们的API按预期工作的重要步骤。使用Postman,我们可以发送请求到我们的API,并查看响应。

1. 打开Postman并创建一个新的请求。

2. 根据需要测试的操作选择相应的HTTP方法,并输入端点URL。

例如,要测试获取所有书籍的端点,选择GET方法并输入http://localhost:3000/books
在这里插入图片描述

3. 发送POST请求

在这里插入图片描述
查看结果:
在这里插入图片描述

4. 发送PUT请求

在这里插入图片描述
查看修改结果:
在这里插入图片描述

总结

本篇博客全面介绍了使用Node.js和Express框架构建RESTful API的过程。从项目的初始化开始,步骤包括了设计直观且遵循REST原则的API端点,实现CRUD操作,到使用Postman工具测试API确保其按预期工作。我们通过实例学习了如何创建、读取、更新、和删除资源(书籍)的端点,以及如何通过Postman发送请求并检查响应。

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

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

相关文章

完美解决 RabbitMQ可视化界面Overview不显示折线图和队列不显示Messages

问题场景: 今天使用docker部署了一个RabbitMQ,浏览器打开15672可视化页面发送消息后不显示Overview中的折线图,还有队列中的Messages,因为我要看队列中的消息数量。 解决方案: 进入容器内部 docker exec -it 容器id…

NumPy库中的np.exp和np.exp2

在NumPy库中,np.exp和np.exp2是两个用于计算指数的函数,但它们的基数不同: np.exp(x):计算自然指数 ex,其中 e 是自然对数的底数,大约等于2.71828。这个函数返回e的x次幂,用于各种自然增长或衰…

Spring Cloud Gateway如何实现熔断

Spring Cloud Gateway熔断集成 熔断应用: 金融市场中的熔断机制:在金融交易系统中,熔断机制(Circuit Breaker)是一种市场保护措施,旨在预防市场剧烈波动时可能导致的系统性风险。当某个基准指数&#xff08…

MySQL数据库(5)——逻辑处理

逻辑处理 在MySQL中,可以使用逻辑运算符和条件语句来进行逻辑处理。 1.逻辑运算符 and 与or 或not 非 这里用法与Java中的用法相同,只是语法发生了部分变化。 2.case——when逻辑处理 语法: case when 条件 then 结果1 else 结果2 end 注…

基于springboot实现驾校信息管理系统项目【项目源码+论文说明】计算机毕业设计

基于springboot实现驾校信息管理系统演示 摘要 随着人们生活水平的不断提高,出行方式多样化,也以私家车为主,那么既然私家车的需求不断增长,那么基于驾校的考核管理也就不断增强,那么业务系统也就慢慢的随之加大。信息…

我们是否生活在一个超大型生物的大脑之中?——对多元宇宙观与生命存在形式的哲学探讨

随着科技和哲学思辨的深入,关于人类所处宇宙的本质及我们自身存在的真实性的讨论越发引人入胜。其中一种颇具科幻色彩的观点认为,我们可能生活在某个巨大生物的大脑之中,所有的物理规律、自然现象以及我们的感知体验,都可能是这个…

15. jwt认证中间件

在上一篇登录功能的实现中,我们使用了jwt作为鉴权组件,其中登录后会颁发token。前端在访问后续请求时,可以带上这个token。对于一些需要权限校验的请求,我们就需要验证这个token,从token中获取到用户id(有了…

MQTT.fx实现(MQTT Client)连接物联网平台(ThingsCloud )

目录 概述 1 ThingsCloud平台介绍 2 ThingsCloud创建项目 2.1 创建项目 2.2 创建数据类型 2.3 创建设备类型 3 发布和订阅主题 3.1 发布Topic 3.2 订阅主题Topic 4 使用MQTT.fx 测试ThingsClond 4.1 使用MQTT.fx连接ThingsClond 4.2 MQTT.fx 订阅ThingsCloud Messag…

【JS】前端分片上传大文件(支持1G以上的超大文件)

目录 什么时候需要分片上传?分片上传流程获取文件专属MD5码 什么时候需要分片上传? 如果将大文件一次性上传,耗时会非常长,甚至可能传输失败,那么我们怎么解决这个问题呢?既然大文件上传不适合一次性上传&…

jenkins+maven+gitlab自动化构建打包、部署

Jenkins自动化部署实现原理 环境准备 1、jenkins已经安装好 docker安装jenkins 2、gitlab已经安装好 docker安装gitlab 一、Jenkins系统配置 1.Global Tool Configuration 任务构建所用到的编译环境等配置,配置参考: jdk配置(jenkins自带…

GCNv2_SLAM-CPU详细安装教程(ubuntu18.04)

GCNv2_SLAM-CPU详细安装教程-ubuntu18.04 前言一、安装第三方库1.安装Pangolin2.安装OpenCV3.安装Eigen4.安装Pytorch(c) 二、安装以及运行GCNv2_SLAM1.安装编译GCNv2_SLAM2.单目模式运行演示案例 总结 前言 paper:https://arxiv.org/pdf/1902.11046.pdf githup::https://gith…

C#进阶-ASP.NET常用控件总结

一、ASP.NET基础控件 1、asp:TextBox (输入框) ASP.NET TextBox 控件用于接收用户输入。 <asp:TextBox ID"txtInput" runat"server"></asp:TextBox>2、asp:DropDownList (下拉框) ASP.NET DropDownList 控件用于提供一个下拉列表供用户选择…

clickhouse sql语句

查看a表的创建语句 SHOW CREATE TABLE a; 删除表b DROP TABLE b;例如&#xff1a; CREATE TABLE ark_us.d_stk_info_us_polygon_cik_5_w (ticker String,t_date DateTime64(6),name Nullable(String),market Nullable(String),type Nullable(String),cik Nullable(String),…

linux 安装gradle7.4.2环境

1.下载gradle7.4.2工程 百度网盘 请输入提取码百度网盘为您提供文件的网络备份、同步和分享服务。空间大、速度快、安全稳固&#xff0c;支持教育网加速&#xff0c;支持手机端。注册使用百度网盘即可享受免费存储空间https://pan.baidu.com/s/1hoNEFkBJPHAgs9ITAEh3Zg?pwdGJ…

linux下test,/usr/bin/test,[],和/usr/bin/[的作用及用法举例

1.test,/usr/bin/test,[],和/usr/bin/[介绍 首先&#xff0c;linux下test,/usr/bin/test,[],和/usr/bin/[命令都是等价命令 其次&#xff0c;linux下test,/usr/bin/test,[],和/usr/bin/[命令一般用来测试文件类型&#xff0c;或者用来比较字符串 test,/usr/bin/test,[],和/u…

DDos攻击如何被高防服务器有效防范?

德迅云安全-领先云安全服务与解决方案提供商 什么是DDos攻击&#xff1f; DDos攻击是一种网络攻击手段&#xff0c;旨在通过使目标系统的服务不可用或中断&#xff0c;导致无法正常使用网络服务。DDos攻击可以采取多种方式实施&#xff0c;包括洪水攻击、压力测试、UDP Flood…

WPF —— TabControl、StackPanel 控件详解

1 TabControl简介 表示包含多个项的控件&#xff0c;这些项共享屏幕上的同一空间。 TabControl有助于最大程度地减少屏幕空间使用量&#xff0c;同时允许应用程序公开大量数据。 TabControl包含共享同一屏幕空间的多个 TabItem 对象。一次只能看到 TabControl 中的一个 Ta…

java的23种设计模式02-创建型模式02-抽象工厂方法

一、抽象工厂方法 1-1、抽象工厂方法的定义 抽象工厂模式是一个比较复杂的创建型模式。 抽象工厂模式和工厂方法不太一样&#xff0c;它要解决的问题比较复杂&#xff0c;不但工厂是抽象的&#xff0c;产品是抽象的&#xff0c;而且&#xff1a;有多个产品需要创建&#xff…

玩转 Spring 状态机:更优雅的实现订单状态流转

说起 Spring 状态机&#xff0c;大家很容易联想到这个状态机和设计模式中状态模式的区别是啥呢&#xff1f;没错&#xff0c;Spring 状态机就是状态模式的一种实现&#xff0c;在介绍 Spring 状态机之前&#xff0c;让我们来看看设计模式中的状态模式。 1. 状态模式 状态模式…

pytorch之诗词生成3--utils

先上代码&#xff1a; import numpy as np import settingsdef generate_random_poetry(tokenizer, model, s):"""随机生成一首诗:param tokenizer: 分词器:param model: 用于生成古诗的模型:param s: 用于生成古诗的起始字符串&#xff0c;默认为空串:return: …