API设计评审规范

技能简介

工程架构级别的API质量把关技能。从端点命名一致性、版本演进策略、认证授权安全到响应性能瓶颈，提供多维度检查清单与改进建议，确保接口设计既符合行业惯例又具备长期可维护性。

能做什么

• 梳理代码结构与模块边界
• 总结技术栈、依赖与风险点
• 输出可复用的工程说明文档

使用说明

• 提供项目目录或目标模块。
• 按结构梳理实现路径与依赖。
• 输出结论并复核关键判断。

run: python scripts/api_linter.py openapi.json

run: python scripts/breaking_change_detector.py openapi-v1.json openapi-v2.json

英文名

api-design-reviewer

输入与输出

见下方输入与输出表格。

风险提示

• 自动分析结论可能忽略业务上下文，关键设计判断仍需工程人员确认。
• 若直接操作仓库或脚本，请先确认执行范围，避免误改核心代码。
• 涉及私有仓库或内部依赖时，应按权限边界处理访问和输出内容。

来源信息

原始链接：https://github.com/alirezarezvani/claude-skills
来源类型：GitHub 开源仓库