SuperAPI AI 工具集

api-contract-review

编程与开发

查看项目

更新于 10-15 20:35

技能介绍

用途:审计 REST API 设计的正确性、一致性与兼容性,覆盖 HTTP 动词语义、版本控制、请求/响应设计、状态码、错误处理与向后兼容。

主要能力:检查动词选择(GET 仅检索、POST 创建返回 201+Location、PUT 全量替换、PATCH 部分更新、DELETE 删除);检查 URL 设计(版本化 /v1/、名词复数、层级关系、命名一致);检查请求校验与 DTO 使用;检查响应 DTO、分页、状态码;检查错误格式统一、机器可读错误码、不暴露堆栈;识别破坏性变更(删除端点/字段、新增必填字段、改类型、重命名、改路径)与非破坏性变更,并给出弃用模式。

使用方式:作为技能在 Claude Code 中调用,按清单逐项审查;大型 API 可先列出控制器 find . -name "Controller.java",抽样 2-3 个分析模式,再 grep 反模式,如 grep -r "public.Entity.@GetMapping" --include=".java"、grep -r "ResponseEntity.ok.error" --include=".java"、grep -r "@RequestMapping.api" --include=".java" | grep -v "/v[0-9]"。

适用场景:发布 API 变更前、审查含控制器改动的 PR、检查向后兼容性。

限制:资料未提供安装命令、收费、平台支持范围及具体效果数据;示例基于 Java/Spring 注解,其他技术栈需自行适配。