api-review
评估API接口设计的规范性、一致性和最佳实践对齐度
安装使用
复制下面这段提示词发给你的 AI（Claude / Cursor / TRAE / Codex / WorkBuddy 等），它会自动帮你完成安装：
帮我安装这个 AI Skill：api-review。 它的用途是：评估API接口设计的规范性、一致性和最佳实践对齐度 完整的 Skill 内容见：https://321skill.com/skills/api-review-x-7/raw/index.md 请读取该页面内容，如果是 SKILL.md 格式直接安装，如果是 README 提炼核心 prompt 后安装。
提示词包含完整的 Skill 内容链接，AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。
使用示例
‘请评审这个用户查询接口的设计：GET /api/v1/getUserInfo?user_id=123，返回字段包括id, name, user_age, create_time。’ 它会分析端点命名（建议使用`/api/v1/users/{id}`）、参数命名（`user_id` vs `id`）和响应字段命名一致性（`user_age` 建议改为 `age`），并指出与RESTful范例的偏差。
介绍
api-review Skill 专注于解决API设计阶段的评审难题。在微服务或前后端分离的架构中，API作为系统间通信的契约，其设计质量直接影响开发效率和系统可维护性。该Skill通过预设的规则和标准，帮助开发者系统性地检查API的命名、参数、响应结构等，确保其符合团队规范与行业最佳实践。
它通过分析用户提供的API接口定义（如OpenAPI/Swagger文档、代码片段或自然语言描述），自动识别设计缺陷、不一致之处以及与团队选定范例的偏差。例如，它会检查端点命名是否遵循RESTful约定，响应状态码使用是否恰当，以及数据结构是否冗余。
该Skill主要适合后端开发、全栈开发和API设计人员，尤其是在团队协作开发或需要维护大型API集合的场景下。对于需要确保API设计质量、统一团队接口风格或进行代码审查的工程师来说，它是一个高效的辅助工具。
使用建议：建议在API设计稿定稿前或代码合并请求（Pull Request）评审阶段使用。为确保评审效果，请尽可能提供完整、清晰的API描述。注意，它主要评估设计层面，对于API的业务逻辑实现、性能或安全性（如认证授权细节）的深度分析能力有限。
核心特点
与一般代码审查工具不同，它专门聚焦于API接口的“设计表面”，强调一致性检查和与预设范例的对齐，而非代码逻辑或性能。它能够将抽象的设计原则转化为具体的、可自动检查的规则项。
注意事项
不适合评估API的内部实现逻辑、性能瓶颈或复杂的安全漏洞。
常见问题
api-review能检查哪些类型的API文档？
支持OpenAPI/Swagger规范、代码中的接口定义片段，以及用自然语言描述的API设计。
它能替代人工代码评审吗？
不能，它是一个辅助工具，用于自动化检查设计规范，最终决策仍需人工结合业务上下文判断。
给 AI 助手的安装指引
如果你的 AI 编程助手（Claude Code、Cursor、TRAE 等）能看到这个页面，把下面这段发给它即可自动完成安装：
请访问 https://321skill.com/skills/api-review-x-7/raw/index.md 读取 api-review 的原始 Skill 定义（Markdown 格式），按其中说明在我的环境里完成安装和配置。
AI 可直接读取的原始 Markdown 地址：/skills/api-review-x-7/raw/index.md（查看排版版本）