讲师中心 微信公众号
AI工具推荐 视频效率加速

如何在 Jest 中正确测试带 URL 参数的 Express API

轻宇大大_5945

轻宇大大_5945

发布时间:2026-07-22 23:31:36

|

1146人浏览过

|

来源于php中文网

原创

如何在 Jest 中正确测试带 URL 参数的 Express API

本文详解如何在 Jest 中测试含动态 URL 参数(如 /universities/:universityName/...)的 Express PUT 接口,解决 req.params 为空导致的 Cannot read properties of undefined 错误,并提供可运行的路由定义、测试写法与关键注意事项。

本文详解如何在 jest 中测试含动态 url 参数(如 `/universities/:universityname/...`)的 express put 接口,解决 `req.params` 为空导致的 `cannot read properties of undefined` 错误,并提供可运行的路由定义、测试写法与关键注意事项。

在使用 Jest + Supertest 测试 Express REST API 时,若接口路径包含动态 URL 参数(例如 ucla、2013、johndoe),必须在路由定义中显式声明参数占位符(如 :universityName),否则 req.params 将始终为空对象,调用 req.params.xxx.toString() 必然抛出 TypeError。

✅ 正确的路由定义方式

应使用 app.put()(或 app.post() 等 HTTP 方法)注册具名参数的路由,而非 app.use() —— 后者用于中间件,不解析路径参数:

const express = require('express');
const updateStudentRoute = require('../handlers/updateStudent');
const app = express();

app.use(express.json());
app.use(express.urlencoded({ extended: true })); // 若需支持表单数据,建议添加

// ✅ 正确:使用具名参数语法,Express 自动填充 req.params
app.put('/universities/:universityName/class/:class/studentalias/:studentAlias', updateStudentRoute);

// ❌ 错误:静态路径 + app.use → req.params 为空
// app.use('/universities/ucla/class/2013/studentalias/johndoe', updateStudentRoute);

module.exports = app; // 便于测试文件导入

对应 handler 中即可安全读取参数:

// handlers/updateStudent.js
function getQuery(req) {
  return {
    universityName: req.params.universityName, // 字符串,无需 .toString()(除非确保非 null/undefined)
    class: req.params.class,
    studentAlias: req.params.studentAlias
  };
}

✅ 正确的 Jest + Supertest 测试写法

避免直接传入 app 实例并手动拼接路径;推荐通过 supertest(app) 创建请求代理,或指定服务地址(需确保服务已启动)。以下为两种推荐方案:

方案一:直接测试内存中 app(推荐,无需启动服务器)

const request = require('supertest');
const app = require('./app'); // 导入配置好的 Express 实例

describe('Update Student Details in Database', () => {
  it('should return 201 when updating student with valid URL params', async () => {
    const response = await request(app)
      .put('/universities/ucla/class/2013/studentalias/johndoe')
      .send({ /* 请求体数据,如更新字段 */ name: 'John Doe', major: 'CS' });

    expect(response.statusCode).toBe(201);
    expect(response.body).toHaveProperty('success', true);
  });
});

方案二:测试运行中的服务(需提前 app.listen())

const supertest = require('supertest');
const request = supertest('http://localhost:3000'); // 确保端口一致

describe('Update Student Details in Database', () => {
  it('should return 201 for valid PUT request', async () => {
    const response = await request
      .put('/universities/ucla/class/2013/studentalias/johndoe')
      .send({ name: 'John Doe' });

    expect(response.statusCode).toBe(201);
  });
});

⚠️ 关键注意事项

  • 参数命名一致性:路由中 :universityName 必须与 req.params.universityName 完全匹配(区分大小写);
  • HTTP 方法匹配:测试使用 .put(),路由必须用 app.put() 注册,app.use() 不识别 HTTP 方法;
  • 响应状态码:Express 默认返回 200,务必在 handler 中显式调用 res.status(201).json(...);
  • 请求体解析:确保已启用 app.use(express.json()) 和 app.use(express.urlencoded({ extended: true }));
  • 路径层级对齐:测试路径 /universities/ucla/... 必须与路由定义 /universities/:universityName/... 前缀完全一致。

遵循以上规范,即可稳定捕获 URL 参数、消除 undefined 错误,并构建可靠、可维护的 API 集成测试。

热门AI工具

更多
讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

4386

2023.06.20

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

1109

2023.07.04

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

4304

2023.07.04

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

880

2023.09.01

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

1756

2023.09.04

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

3165

2023.09.04

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

4113

2023.09.12

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

2660

2023.09.20

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

0

2026.09.30

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Express 中文开发手册
Express 中文开发手册

共0课时 | 1人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn