API 契约与破坏性变更检查

原名：api-design-reviewer

比较 OpenAPI 版本、命名和错误结构，整理接口兼容风险。

中文 Skills 技能说明

客户端还在调用旧接口，服务端改动前应先查兼容性。提供当前与候选 OpenAPI 文档、版本规则和消费方约束，技能运行包内检查工具，整理路径、参数、响应及破坏性变更，交付问题清单和设计评分依据。规范检查不覆盖全部业务逻辑，评分也不是接口已经可用的证明；实际联调仍要检查认证、分页、错误和跨公司权限。保留现有 URL，令牌不进文档或日志，变更方案与正式发布由负责人确认。

上游能力依据

上游原始适用说明：Comprehensive REST API design review with automated linting, breaking-change detection, and design scorecards. Catches inconsistent conventions, missing versioning, and design smells before APIs ship. Use when reviewing a PR that adds or changes API endpoints, auditing an existing API for v2 migration, or establishing API standards for a team.

上游 SKILL.md 主要章节（保留原文标题）：

Overview
Quick Start — run the tools first
Core Capabilities
1. API Linting and Convention Analysis
2. Breaking Change Detection
3. API Design Scoring and Assessment
REST Design Principles
Resource Naming Conventions
HTTP Method Usage
URL Structure Best Practices

使用边界

先读取项目约定、依赖版本和现有测试，再提出最小改动。写文件、运行脚本、提交代码或发布前应检查差异并保留回退路径。

作者、翻译与许可证

原作者: Alireza Rezvani 与 claude-skills contributors
中文翻译: CEOFans翻译
许可证: MIT
上游来源: https://github.com/alirezarezvani/claude-skills/tree/27cfcd0fb0a41f60adffcbd5271fdf8839f86ed2/engineering/skills/api-design-reviewer

适用范围

平台：linux、macos、windows；标签：架构与规划、API 契约与破坏性变更检查、开源技能

安全提示

基础静态扫描不等于绝对安全。技能可能调用命令、浏览器、云服务或本地文件，请在最小权限环境中使用，高风险操作必须人工确认。

如发现侵权、许可证或安全问题，可在本页前台提交投诉，管理员复核后可立即下架。