api-review
评估API接口设计一致性与示例对齐
安装使用
复制下面这段提示词发给你的 AI（Claude / Cursor / TRAE / Codex / WorkBuddy 等），它会自动帮你完成安装：
帮我安装这个 AI Skill：api-review。 它的用途是：评估API接口设计一致性与示例对齐 完整的 Skill 内容见：https://321skill.com/skills/api-review-x-4/raw/index.md 请读取该页面内容，如果是 SKILL.md 格式直接安装，如果是 README 提炼核心 prompt 后安装。
提示词包含完整的 Skill 内容链接，AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。
使用示例
'请审查这个API定义文件，检查命名规范、参数一致性以及是否与示例对齐。' 它会解析文件内容，逐条列出设计不一致的问题，如参数名称风格不统一、响应字段缺失、示例与schema不匹配等，并给出修复建议。
介绍
在API开发过程中，接口设计的一致性直接影响系统的可维护性和团队协作效率。该Skill专注于自动评估API的表面设计，包括命名规范、参数风格、响应格式以及示例对齐程度，帮助开发者快速发现设计中的不一致问题。
使用方式非常简单：您只需提供API定义文件（如OpenAPI、GraphQL schema或代码中的接口声明），该Skill会逐项检查设计规范，并输出详细的评估报告，指出不一致之处并给出改进建议。它支持批量检查多个接口，并可与CI/CD流程集成。
适合后端开发、全栈开发以及API架构师，特别适合在代码审查阶段或设计评审会上使用，能够减少人工审查的遗漏，提升API设计质量。
建议将本Skill作为团队API设计规范自动化检查的一环，与代码审查工具配合使用。注意它仅评估设计层面，不涉及运行时性能或安全漏洞，需要结合其他工具进行完整质量保障。
核心特点
与通用代码审查工具不同，本Skill专注于API设计规范的一致性，并能自动比对接口定义与示例是否对齐，识别出参数缺失、类型不匹配等细节问题，而非仅检查语法错误。
注意事项
不适合评估API运行时性能、安全漏洞或业务逻辑正确性。
常见问题
这个Skill支持OpenAPI 3.0规范吗？
支持，它能够解析OpenAPI 3.0/3.1以及Swagger 2.0格式的API定义文件。
能检查GraphQL接口吗？
支持GraphQL schema，会检查类型定义、参数命名一致性和示例对齐。
给 AI 助手的安装指引
如果你的 AI 编程助手（Claude Code、Cursor、TRAE 等）能看到这个页面，把下面这段发给它即可自动完成安装：
请访问 https://321skill.com/skills/api-review-x-4/raw/index.md 读取 api-review 的原始 Skill 定义（Markdown 格式），按其中说明在我的环境里完成安装和配置。
AI 可直接读取的原始 Markdown 地址：/skills/api-review-x-4/raw/index.md（查看排版版本）