Strapi 中 @strapi/openapi 包的单元测试指南:Route 收集、匹配器与文档组装器的测试实践
Strapi 中 strapi/openapi 包的单元测试指南Route 收集、匹配器与文档组装器的测试实践【免费下载链接】strapi Strapi is the leading open-source headless CMS. It’s 100% JavaScript/TypeScript, fully customizable, and developer-first.项目地址: https://gitcode.com/GitHub_Trending/st/strapiStrapi 的 OpenAPI 文档生成功能由strapi/openapi包提供它负责从运行中的 Strapi 实例收集 API 路由并将路由上的 Zodrequest/response模式转换成 OpenAPI 规范。修改该包后仅靠肉眼检查生成的 YAML 往往不够——你需要一套可重复执行的单元测试来验证路由收集、规则匹配和文档组装的行为。读完本篇你将掌握在该包中编写单元测试的完整套路如何运行测试、如何用StrapiMock模拟 Strapi 实例、如何测试RouteMatcher规则、如何通过OperationContextFactory驱动各类 assembler 并断言输出以及失败时如何用 debug 命名空间定位问题。测试位置与工具链单元测试统一存放在tests目录 下从包目录运行cd packages/core/openapi yarn test:unit共享的 fixture 与 mock 位于__tests__/fixtures/和__tests__/mocks/中新测试应优先复用它们而不是各自重新造轮子。从 package.json 可以看到test:unit实际执行的是run -T jest即在仓库根目录上下文运行 Jest另有一个test:unit:watch脚本对应jest --watch方便本地反复调试。而 jest.config.js 则揭示了这套测试的几个关键约定preset: ../../../jest-preset.unit.js复用仓库根部的单元 Jest 预设保证所有包的单元测试行为一致transform使用swc/jest编译 TypeScript 测试文件testMatch: [rootDir/__tests__/**/*.test.ts]只有落在__tests__下、且以.test.ts结尾的文件才会被收集新增测试文件必须遵守这个命名约定collectCoverageFrom特意覆盖为rootDir/src/**/*.{js,ts}并排除dist、node_modules、配置文件等。注释里解释了原因根级 Jest 配置的rootDir/packages/**在子包内运行时会解析成packages/core/openapi/packages/**导致 CI 中覆盖率收集失效因此子包必须显式重写该配置。此外test:ts脚本会跑tsc -p tsconfig.json所以测试代码中的类型错误也会被 CI 拦截——在写 mock 时保持类型正确是硬性要求而不是风格偏好。测试 Route Provider用 StrapiMock 模拟 Strapi 实例strapi/openapi通过一组 route provider 从 Strapi 实例中抽出路由ApiRoutesProvider 负责strapi.apisPluginRoutesProvider 负责strapi.plugins。从源码结构看ApiRoutesProvider.routes只做两件事——把apis的每个 API 的 router 展平、再把每个 router 的routes展平最后返回一个Core.Route[]。这意味着测试 provider 时只需 mock 出 provider 实际读取的那部分 Strapi 属性即可不需要一个真实的 Strapi 实例。仓库为此提供了 StrapiMockimport type { Core } from strapi/types; import { ApiRoutesProvider } from ../../src/routes; import { StrapiMock } from ../mocks; it(returns registered API routes, () { const strapi new StrapiMock() as unknown as Core.Strapi; const provider new ApiRoutesProvider(strapi); expect(provider.routes.length).toBeGreaterThan(0); });这个 mock 的构造方式值得理解因为它精确对应了 provider 的解析逻辑apis是一个 getter返回api-a、api-b两个 API各自挂在router-a、router-b下面路由数据来自 fixtures/routes.ts 中的routes.test与routes.foobarplugins则故意覆盖插件路由的两种合法形态plugin-a的routes是直接的Route[]而plugin-b的routes是Recordstring, { routes: Route[] }。这与 PluginRoutesProvider 源码中的分支一致——它对Array.isArray(routes)直接返回否则按 router 记录展平并且会为每条路由计算effectivePrefix路由自带config.prefix时优先否则回退到 router 的prefix最后做斜杠归一化。fixture 本身也很小但覆盖了多种路由类型routes.test包含一条GET /api/test1content-api、一条POST /test2admin和一条DELETE /api/test3content-apiroutes.foobar则是 PUT/PATCH/HEAD 各一条。混入 admin 类型路由并非随意——provider 层只负责收集过滤属于哪类路由是下游 matcher 的职责这类断言在 routes 目录下的测试如api-routes-provider.test.ts、plugins-route-provider.test.ts、collector.test.ts中都有对应。测试 Matcher 规则最小化 Core.RouteRouteMatcher 的实现极其克制构造时接收一个MatcherRule[]每条规则是(route) boolean的谓词match方法用every短路求值——任何一条规则失败立即返回false。因此测试它只需要构造一个最小可用的Core.Routeimport type { Core } from strapi/types; import { RouteMatcher } from ../../src/routes; const route: Core.Route { method: GET, path: /api/articles, handler: , info: { type: content-api }, }; expect(new RouteMatcher([(r) r.method GET]).match(route)).toBe(true);注意Core.Route要求四个字段method、path、handler字符串测试里给空串即可以及info.type后者是路由分类content-api、admin等的依据。仓库里现成的规则实现在 rules 目录 中如is-of-type.ts而 route-matcher.test.ts 展示了如何围绕这些规则组合断言。写新规则测试时的原则是一条规则只验证一个谓词维度method、path、info.type多规则组合的行为则验证every的短路语义如一条真一条假时应返回 false。测试 Assembler从 Context 到 output 的完整链路OpenAPI 文档的生成过程被拆成一系列 assembler通过 context 传递中间状态。以 operation 层为例operation 目录 下分别有parameters.ts、body.ts、responses.ts、tags.ts、operation-id.ts等 assembler加上factory.ts的装配。测试这类组件的固定套路是用对应的 ContextFactory 创建上下文 → 运行 assembler → 断言context.output.data。import type { Core } from strapi/types; import * as z from zod/v4; import { OperationParametersAssembler } from ../../src/assemblers/document/path/path-item/operation; import { OperationContextFactory } from ../../src/context; const context new OperationContextFactory().create({ strapi: {} as Core.Strapi, routes: [] }, {}); new OperationParametersAssembler().assemble(context, { method: GET, path: /api/articles/:id, handler: , info: { type: content-api }, request: { params: { id: z.string() }, query: { locale: z.string().optional() }, }, }); expect(context.output.data.parameters).toEqual( expect.arrayContaining([ expect.objectContaining({ name: id, in: path }), expect.objectContaining({ name: locale, in: query }), ]) );这里有几个要点Context 由工厂创建不要手工拼装。OperationContextFactory定义在 context/factories 下document.ts、path.ts、path-item.ts、operation.ts层层对应文档树结构工厂负责初始化output的初始形状测试只需传入{ strapi, routes }这类最小输入路由的 Zod 模式是 assembler 的主要输入。上面例子里request.params.id被解析为in: path的参数request.query.locale因带.optional()仍会生成参数但标记为可选断言用arrayContainingobjectContaining因为parameters数组中可能混有 operation 自身的参数与共享参数精确全等断言过于脆弱。对于 content-api 场景下通过strapi.contentAPI.addQueryParams/addInputParams动态注入的参数参考 operation-assemblers.test.ts该测试文件先构建一个 mock 的 contentAPI 服务带addQueryParams、addInputParams、mergeQueryParamsIntoRoute、mergeInputParamsIntoRoute模拟 content-api service 将额外参数合并进route.request.query与route.request.body的过程再运行 assembler 断言生成的参数与 body 中包含这些字段。它头部的注释也点明了关键事实OpenAPI spec 生成器读的是route.request所以任何注入到请求模式中的参数最终都必须能通过 assembler 出现在输出里——这也是写新测试时的验证锚点。调试失败的测试debug 命名空间当断言失败但看不出 assembler 或 provider 在哪一步跑偏时打开包级 debug 输出cd packages/core/openapi DEBUGstrapi:core:openapi:* yarn test:unit这个命名空间由 constants.ts 中的DEBUG_NAMESPACE strapi:core:openapi定义createDebugger 会在此基础上拼接各模块的 section 名。例如ApiRoutesProvider内部用createDebugger(routes:provider:api)路由收集完成后会打印found %o routes in Strapi APIsPluginRoutesProvider则对应routes:provider:plugins。因此用DEBUGstrapi:core:openapi:routes:*这样的模式可以只聚焦路由收集阶段用通配*则能看到整个包的完整链路日志。debug 命名空间的整体约定在 OpenAPI 贡献文档的 Technologies 页面位于docs/docs/docs/01-core/openapi/contributing/同级文档中有进一步说明可作为补充阅读。小结为strapi/openapi写单元测试的核心思路可以概括为三点mock 到最小provider 测试只需StrapiMock暴露的apis/plugins两个属性matcher 测试只需四字段的最小Core.Route、沿工厂链路构造 contextassembler 测试统一走 ContextFactory → assemble → 断言context.output.data、用 debug 命名空间定位DEBUGstrapi:core:openapi:*。所有约定都有仓库内的现成参照——mocks 目录下的StrapiMock、fixtures 下的路由样本以及tests根目录 下的document-assemblers.test.ts、zod-to-openapi.test.ts等测试文件——新测试照此展开就能与包内既有的测试风格和覆盖率配置保持一致。【免费下载链接】strapi Strapi is the leading open-source headless CMS. It’s 100% JavaScript/TypeScript, fully customizable, and developer-first.项目地址: https://gitcode.com/GitHub_Trending/st/strapi创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考

相关新闻

《天涯》诵经版Cover背后:音频二创工程全拆解

《天涯》诵经版Cover背后:音频二创工程全拆解

《天涯》诵经版Cover,这个标题我第一眼看到时是直接划走的。这几年太多二创作品喜欢在歌名后面挂一个“风格后缀”,什么慢速版、Lofi版、深夜版,我当时以为这也只是把任贤齐的老歌放慢、再加一段木鱼节奏的整活音频。直到后来在一个推荐流里完…

2026/11/16 19:50:02 阅读更多 →
Apktool 解包重打包 5 步实战:如何把 APK 拆开改再装回去

Apktool 解包重打包 5 步实战:如何把 APK 拆开改再装回去

Apktool 解包重打包 5 步实战:如何把 APK 拆开改再装回去 【免费下载链接】Apktool A tool for reverse engineering Android apk files 项目地址: https://gitcode.com/GitHub_Trending/ap/Apktool Apktool 是一个把 Android 的 apk 文件拆开、改资源、再打…

2026/11/16 19:50:02 阅读更多 →
Calibre 电子书格式转换实操:3 个高频场景一次讲透

Calibre 电子书格式转换实操:3 个高频场景一次讲透

Calibre 电子书格式转换实操:3 个高频场景一次讲透 【免费下载链接】calibre The official source code repository for the calibre ebook manager 项目地址: https://gitcode.com/GitHub_Trending/ca/calibre 你的电子书格式和设备对不上?Kindl…

2026/11/10 1:00:39 阅读更多 →

最新新闻

Electron桌面应用开发实战:从环境搭建到打包发布全流程

Electron桌面应用开发实战:从环境搭建到打包发布全流程

做前端这些年,我大部分时间都在跟浏览器标签页打交道,直到第一次把桌面应用跑起来,才发现原来自己一直被限制在地址栏和刷新按钮围起来的框框里。Electron这个词,最开始是在某段时间频繁出现在同事的讨论里,一个用HTML…

2026/11/16 8:22:12 阅读更多 →
滑盖智能锁T109深度解析:结构原理、安装调试与故障排查

滑盖智能锁T109深度解析:结构原理、安装调试与故障排查

简介:亚太天能T109滑盖智能锁产品说明书是一份PDF格式的官方技术文档,主要面向智能锁安装人员、终端用户及售后维护者,帮助快速掌握产品安装、配置与常见故障处理。全包仅1个PDF文件,大小4.37MB,内容结构清晰&#xff…

2026/11/16 6:41:34 阅读更多 →
PMSM弱磁控制原理与Simulink建模:高速AGV驱动系统设计指南

PMSM弱磁控制原理与Simulink建模:高速AGV驱动系统设计指南

上个月我在调试一台高速AGV的驱动系统,整车要求空载跑到8m/s,电机转速已经拉到额定点,驱动器的输出电压也顶到了母线电压极限附近。再往上踩速度指令,转速纹丝不动,三相电流反而开始震荡。那会儿我的第一反应就是&…

2026/11/16 8:22:12 阅读更多 →
C++核心知识点:从内存管理到STL的实战指南

C++核心知识点:从内存管理到STL的实战指南

C 这门语言我前前后后折腾了十几年,用它写过嵌入式驱动、做过游戏服务端,也搭过基础组件库。每次看到新人一头扎进"C 核心知识点"这个搜索词,我其实挺感慨的——这门语言的难点从来不是语法多,而是知识点之间的耦合太深…

2026/11/16 8:22:12 阅读更多 →
T109滑盖智能锁怎么装?安装调试与故障排查全攻略

T109滑盖智能锁怎么装?安装调试与故障排查全攻略

简介:亚太天能T109滑盖智能锁产品说明书以PDF格式发布,适合智能锁用户、安装人员与售后维修人员阅读。内容围绕T109系列指纹密码刷卡锁展开,先介绍前面板、后面板、锁体、机械钥匙、电池盒盖等部件名称与功能,再给出完整安装步骤&…

2026/11/16 7:30:18 阅读更多 →
LLM知识降熵:从信息垄断到理解权下放

LLM知识降熵:从信息垄断到理解权下放

你有没有过这种经历:翻开源码注释、论文摘要或者一份专业报告,每个字都认识,连在一起却像天书。想找人聊聊,身边要么没人懂,要么懂的懒得跟你解释。后来我试着把同一段内容丢给一个大语言模型,几秒钟之后&a…

2026/11/16 8:22:12 阅读更多 →

日新闻

周新闻

月新闻