用途:审查 API 设计,检查最佳实践、一致性和潜在问题。
用法:命令为 /sd:api-review [spec-file-or-pattern]。参数为可选,可指定 OpenAPI 规范、API 文件或 glob 模式;提供时审查指定文件,省略时自动搜索常见 API 规范文件(如 openapi.yaml、swagger.json 等),并查找代码中的路由与端点定义。示例:/sd:api-review openapi.yaml、/sd:api-review src/api/**/*.ts、/sd:api-review。
流程:先定位 API 定义;再调用 api-reviewer 代理识别 API 类型(REST、GraphQL、gRPC),依据已加载技能应用最佳实践,生成结构化审查报告;最后按严重程度展示结果。
审查内容:REST 侧重资源命名与 URL 结构、HTTP 方法、状态码、错误响应格式、分页模式;GraphQL 侧重 schema 设计、查询复杂度、N+1 预防、错误处理;gRPC 侧重消息设计、服务模式、向后兼容。通用方面涵盖版本策略、限流、幂等性、安全模式、文档质量。
输出:包含 API 摘要与总体评估、按严重程度分类的问题、带示例的具体建议,以及值得保留的正面模式;问题分为必须修复的严重问题、应处理的警告、可选建议和正面观察。
限制:资料未说明该命令的收费、价格、平台及具体效果,均暂未提供;其行为依赖 Claude Code 插件环境与已加载技能。