api-diff

api-diff 是一款专为前端开发者设计的 API 契约监控工具，能够在用户察觉之前，自动捕获并报告 API 响应与预期结构之间的差异。当后端悄然修改字段、前端静默出错、TypeScript 类型逐渐过时，这些问题往往在用户投诉后才被察觉。api-diff 通过拦截每一次 fetch 请求，并将实际响应与您预先定义的 schema 进行深度比对，一旦发现漂移，立即通知您。

核心功能

api-diff 的核心在于其强大的深度比对引擎。它支持通配符路由，允许您灵活匹配多个 API 端点；严格模式可确保响应结构与 schema 完全一致；细粒度的忽略模式让您能够排除已知的、可接受的差异。此外，onDrift 回调函数可无缝集成 Sentry 或分析工具，实现实时告警。

主要特性

• 零依赖：无需安装额外包，轻量集成，不增加项目负担。
• 完整 TypeScript 支持：提供类型定义，确保开发体验流畅。
• 深度差异检测：递归比较对象、数组、嵌套结构，不放过任何细微变化。
• 灵活配置：支持通配符、严格模式、忽略规则，适应不同项目需求。
• 即时反馈：通过回调机制，漂移发生时立即触发告警，缩短响应时间。

适用场景

• 前后端协作：当后端接口频繁变动，前端需要快速感知并调整。
• 微服务架构：多个服务独立演进，API 契约容易产生偏差，api-diff 可充当契约守护者。
• 第三方 API 集成：监控外部服务响应变化，避免因上游变更导致应用故障。

总之，api-diff 是前端工程师的“契约守护神”，让 API 漂移无处遁形，确保应用稳定运行。