用途:统一各端点的 API 契约,提升一致性与开发者体验。主要能力:审计现有 API 不一致点;定义标准响应信封(success/data/error/meta);统一分页(页码式与游标式)与查询参数;建立错误分类(ErrorCode)及错误到 HTTP 状态码映射;提供响应与错误归一化中间件;定义 URL、Header、查询参数三种版本策略;输出 OpenAPI 规范与分阶段迁移计划。使用方式:先审计并定义标准,再创建共享 TypeScript 类型,接入 normalizeResponse 与 normalizeError 中间件,按阶段迁移(新增归一化、弃用通知、双格式支持、切换默认、移除旧格式),并用 OpenAPI 作为契约来源。适用场景:多端点响应格式混乱、前后端类型不一致、需要统一分页与错误处理、计划 API 版本演进的项目。限制:资料未提供具体安装命令、依赖版本、框架适配范围、性能数据与收费信息;示例基于 Express 与 TypeScript,其他技术栈需自行适配。
api-contract-normalizer
编程与开发
更新于 10-16 03:16