API契约测试
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @kunlungrowth/kunlun-testing-api-contract。
技能介绍
联调扯皮往往从「接口没定死」开始
前后端各自实现、文档滞后或字段命名不一致时,契约漂移会在联调与上线后才暴露:多传少传字段、错误码不可解析、版本升级破坏兼容。技术负责人也常在 PR 里缺少可复用的评审标准——不知道该把问题标成阻断还是建议。本技能把 API契约测试 场景嵌进一套工程方法论:用结构化输入换结构化输出,而不是泛泛聊「最佳实践」。
技能如何工作
听到「接口/API/契约」等触发词会进入 API 设计 能力:你提供资源与操作(例如用户注册、订单查询),产出 RESTful 规范、字段契约与错误码约定,便于写进设计文档或 OpenAPI 草案。其它能力可组合使用:
- 代码评审:对 API 相关 diff/PR 按正确性、安全、可维护性分级(阻断/建议/可选)
- 技术方案设计:在需求与约束下输出背景、目标、选型与风险的方案模板
- 调试排错:用报错与上下文生成定位树、复现步骤与修复验证清单
- 架构权衡:按场景与规模做选型对比(利弊、适用、成本)
- 工程规范:按语言/框架给出清单与反模式
核心工作流强调先读懂改动意图再判正确性;线上排错则要求 先稳定复现、再看日志/链路证据,避免未复现就改代码。
适用边界与注意点
技能只提供模板、检查清单与方法论,不替代合并决策或资质判断,也不接入付费服务或处理真实密钥。涉及凭证的内容仅给脱敏示例。评审与方案输出需你补充具体人群、场景与约束,贴合度才更高。
使用场景
- 新接口开发前,要把资源路径、请求响应字段和错误码写成团队可对齐的契约草案
- 联调频繁出现字段类型不一致,需要按契约清单排查是文档还是实现偏差
- 评审 API 相关 PR 时,要按阻断/建议分级标出越权、幂等与边界问题
- 线上返回非约定错误码,需用复现步骤和日志证据定位契约破坏点
适合人员
- 负责对外 REST 接口的后端工程师,希望在编码前就把字段与错误码定稿
- 带前后端协作的全栈工程师,联调阶段要对齐契约并快速排查 4xx 契约类故障
- 把关发布质量的技术负责人,需要在 API 改动 PR 里用统一清单做分级评审
- 维护多服务集成的 DevOps,要在变更评审中核对接口版本与向后兼容风险