api-review
评估API设计一致性及示例对齐
安装使用
复制下面这段提示词发给你的 AI（Claude / Cursor / TRAE / Codex / WorkBuddy 等），它会自动帮你完成安装：
帮我安装这个 AI Skill：api-review。 它的用途是：评估API设计一致性及示例对齐 完整的 Skill 内容见：https://321skill.com/skills/api-review-x-8/raw/index.md 请读取该页面内容，如果是 SKILL.md 格式直接安装，如果是 README 提炼核心 prompt 后安装。
提示词包含完整的 Skill 内容链接，AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。
使用示例
'审查我项目中的OpenAPI定义文件，检查是否符合RESTful命名规范并与示例库对齐'，它会自动解析所有接口，输出路径命名、参数风格、状态码使用等维度的合规性报告，并标记与示例不一致的地方。
介绍
本Skill专注于自动化评估API表面的设计质量，包括接口命名、参数结构、返回格式、错误处理等维度的规范一致性，并检查与参考示例的对齐程度。它能够快速扫描API定义文件（如OpenAPI/Swagger、GraphQL Schema、gRPC proto等），输出一份结构化报告，指出不符合团队规范或行业最佳实践的问题点，以及偏离示例模式的地方。
使用时，只需将API定义文件或相关代码提供给AI，该Skill会自动解析并执行检查。支持自定义检查规则（如要求所有路径使用小写+连字符、所有响应包含统一错误编码等），也可加载预设的示例库进行比对。检查结果会以列表形式呈现，附带具体位置和修改建议。
适合后端开发、全栈开发、智能体开发等需要设计或维护API的工程师。尤其对微服务架构中多个团队各自维护不同API、需要统一设计规范并保证跨服务一致性时，能显著提升代码审查效率。也适用于在CI/CD流程中自动拦截不合规的API变更。
建议在使用前先定义好团队API设计规范并转化为检查规则文件；若没有现成规范，可先使用内置的通用RESTful/GraphQL最佳实践规则。注意该Skill仅检查API表面设计，不涉及业务逻辑正确性、性能或安全漏洞（需配合其他工具）。此外，对于高度自定义或非标准API协议（如自定义二进制协议）可能无法有效评估。
核心特点
与常规代码审查工具不同，它专注于API表面设计的一致性（命名、结构、风格）和与参考示例的精确对齐，而非代码实现的正确性或性能问题。
注意事项
不适合评估API内部实现逻辑、业务正确性、安全漏洞或性能瓶颈，且对非标准自定义协议支持有限。
常见问题
支持哪些API规范格式？
支持OpenAPI 3.x、Swagger 2.0、GraphQL Schema、gRPC proto等常见格式，也可通过插件扩展自定义格式。
如何自定义检查规则？
在项目根目录添加`.api-review-config.json`文件，按文档格式编写规则，支持路径模式、命名风格、参数约束等。
给 AI 助手的安装指引
如果你的 AI 编程助手（Claude Code、Cursor、TRAE 等）能看到这个页面，把下面这段发给它即可自动完成安装：
请访问 https://321skill.com/skills/api-review-x-8/raw/index.md 读取 api-review 的原始 Skill 定义（Markdown 格式），按其中说明在我的环境里完成安装和配置。
AI 可直接读取的原始 Markdown 地址：/skills/api-review-x-8/raw/index.md（查看排版版本）