【免费下载链接】emulateLocal API emulation for CI and no-network sandboxes项目地址https://gitcode.com/gh_mirrors/emul/emulate点击查看免费下载emulate 是一个面向 CI 和无网络沙箱的本地 API 模拟器其程序化 API 可以把 GitHub、Stripe、Vercel、Slack、Google 等十余种服务直接嵌入你的 Vitest 或 Jest 测试中——不是 mock 打桩而是完整有状态的仿真服务让测试代码以为自己打的是真 API。本文将带你完整走一遍createEmulator启动、reset()重置、snapshot()/restore()快照恢复的实战流程。为什么要在测试里用 emulate 程序化 API传统做法是手写 mock每个接口都要手工编造返回值接口一变测试就大面积失效。emulate 的思路完全不同——它在本地启动一个真实行为的 HTTP 服务响应格式、状态持久化、Webhook 签名、OAuth 流程都与生产环境高度一致你的业务代码照常调用官方 SDK只是把地址指向本地端口。在测试场景下它带来三个直接好处✅零外部依赖CI 跑测试不需要任何真实账号、API Key 或网络✅状态完全可控每个用例开始前一键重置回出厂数据✅有状态仿真创建的仓库、订单、消息会真实落库可连续多步断言核心能力都集中在 api.ts 这一个模块里类型定义见 Emulator 接口成员说明url正在运行的服务地址如http://localhost:4001generatedSecrets启动时自动生成的密钥只读reset()清空全部状态并重新灌入种子数据close()关闭 HTTP 服务器返回 Promise30秒上手createEmulator 启动内置服务安装依赖后即可按服务名启动任意内置服务源码位于 packages/emulate/src/import { createEmulator } from emulate const github await createEmulator({ service: github, port: 4001 }) github.url // http://localhost:4001 await github.close()createEmulator支持的常用选项选项默认值作用service必填服务名github、stripe、slack、vercel等 14 种port4000HTTP 端口seed无内联种子数据结构同 YAML 配置文件baseUrl无覆盖对外公布的地址OAuth 回调、Webhook 地址用 小技巧seed让你无需准备emulate.config.yaml测试中直接内联注入用户、仓库、产品等初始数据完整配置示例可参考根目录的 emulate.config.example.yaml。Vitest / Jest 通用装配模板官方推荐的测试装配模式出处见 programmatic-api 文档非常简洁beforeAll里并行启动、afterEach里reset()、afterAll里close()// vitest.setup.tsJest 中放入 jest.setup 文件写法一致 import { createEmulator, type Emulator } from emulate let github: Emulator let vercel: Emulator beforeAll(async () { ;[github, vercel] await Promise.all([ createEmulator({ service: github, port: 4001 }), createEmulator({ service: vercel, port: 4002 }), ]) // 把地址注入环境变量业务 SDK 直接读它 process.env.GITHUB_EMULATOR_URL github.url process.env.VERCEL_EMULATOR_URL vercel.url }) afterEach(() { github.reset(); vercel.reset() }) afterAll(() Promise.all([github.close(), vercel.close()]))Vitest在vitest.config.ts的test.setupFiles中登记该文件即可Jest在jest.config的setupFilesAfterEnv中登记钩子函数同名兼容这套模式的关键思想实例只建一次状态每例必清。reset()让每个用例都从出厂设置开始reset()会清空内存存储并重新执行种子数据测试间互不污染。看一个真实的用例摘自 api.test.tsconst github await createEmulator({ service: github, port: 14020, seed: { github: { users: [{ login: test-user }] } }, }) // 用例A创建一个仓库 await fetch(${github.url}/user/repos, { method: POST, /* ... */ }) github.reset() // 状态清零回到 seed 定义的样子 // 用例B此时仓库列表必然为空断言稳定可重复 const repos await (await fetch(${github.url}/user/repos, { headers: auth })).json() expect(repos).toHaveLength(0)两个值得注意的细节生成的密钥跨 reset 保持稳定。若 GitHub App 省略了private_keycreateEmulator会自动生成 RSA-2048 密钥并放在generatedSecrets中——即使反复reset()密钥不变测试里签发的 JWT 始终有效显式配置的密钥永远不会出现在generatedSecrets里避免密钥泄漏进测试日志快照实战snapshot() 与 restore() 的分工内置服务的状态管理靠reset()就够了但如果你用defineEmulator写了自定义 API比如订单、库存系统emulate 还提供了更细粒度的快照能力。官方示例见 custom-apis 文档const api await createEmulator({ service: counter, listen: false }) const checkpoint api.snapshot() // ① 打快照 await api.request(/increment, { method: POST }) await api.restore(checkpoint) // ② 恢复回快照 await api.reset() // ③ 回到最初种子 await api.close()三者的区别一句话记住操作效果reset()回到最初种子reset 基线snapshot()对当前状态打一份独立副本带格式与版本元数据restore(checkpoint)把当前状态换回快照值但不改变reset 基线⚠️ 快照带有版本保护定义里可以声明stateVersion改了状态结构后不兼容的旧快照会显式报错而不是悄悄恢复出脏数据相关测试见 custom.test.ts。免端口测试listen: false写自定义模拟器测试时还可以完全不占用端口示例项目见 examples/custom-api/const api await createEmulator({ service: inventory, listen: false }) const res await api.request(/reservations, { method: POST }) // 201api.request(path, init)与走 HTTP 共用同一套 handler速度更快、零端口冲突如果你的 SDK 强制要求 URL改用port: 0让系统自动分配端口再读api.url即可。实战演示用 emulate 测 Stripe 支付流程仓库内置的 stripe-checkout 示例 就是这套模式的落地官方stripeSDK 把host指向本地模拟器产品、价格、Checkout Session 全部由seed注入支付完成后还会触发带Stripe-Signature签名的真实 Webhook 流程——全程不花一分钱、不发一个真实请求。测试下单 → 支付 → Webhook 落单链路时典型的断言节奏是afterEach中stripe.reset()保证每个用例看到的是同一批种子产品用api.request或直接fetch创建 Checkout Session断言 Webhook 是否收到checkout.session.completed事件需要多阶段状态时先snapshot()存档失败分支测试完restore()回到分叉点最佳实践清单 端口错开多服务并行启动时各自指定端口如 4001/4002避免默认 4000 冲突实例必须 closeafterAll里统一Promise.all([a.close(), b.close()])否则测试进程可能挂住seed 要完整自定义模拟器的seed是整体替换而非深合并请提供完整状态对象密钥走 generatedSecrets需要自动密钥时省略配置项运行时从实例上读取CI 场景优先 listen: false自定义 API 测试不开端口跑得更快更稳清理放 try/finally单个用例内临时创建的实例用finally { await api.close() }兜底延伸阅读程序化 API 完整选项表programmatic-api/page.mdx自定义 API 生命周期种子、重置、快照、持久化custom-apis/page.mdxcreateEmulator实现与类型packages/emulate/src/api.ts自定义模拟器可运行的完整示例与测试inventory.ts、inventory.test.ts赞分享【免费下载链接】emulateLocal API emulation for CI and no-network sandboxes项目地址https://gitcode.com/gh_mirrors/emul/emulate点击查看免费下载相关推荐使用 emotion/jest 测试 Emotion 样式组件快照序列化器与 toHaveStyleRule 匹配器完整实战使用 emotion/jest 测试 Emotion 样式组件快照序列化器与 toHaveStyleRule 匹配器完整实战 emotion/jest 是前端Linkerd2-proxy架构深度解析从入口流量到出口流量的完整处理流程Linkerd2 proxy架构深度解析从入口流量到出口流量的完整处理流程 Linkerd2 proxy是Linkerd服务网格的专用代理采用Rust编写服务网格网络云原生微服务后端emulate状态持久化实战KV适配器、filePersistence与版本化快照快速上手emulate状态持久化实战KV适配器、filePersistence与版本化快照快速上手 emulate 是一个本地 API 模拟local API em创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考