api-review
评估API接口设计的一致性与规范性
安装使用
复制下面这段提示词发给你的 AI（Claude / Cursor / TRAE / Codex / WorkBuddy 等），它会自动帮你完成安装：
帮我安装这个 AI Skill：api-review。 它的用途是：评估API接口设计的一致性与规范性 完整的 Skill 内容见：https://321skill.com/skills/api-review-x-2/raw/index.md 请读取该页面内容，如果是 SKILL.md 格式直接安装，如果是 README 提炼核心 prompt 后安装。
提示词包含完整的 Skill 内容链接，AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。
使用示例
‘请评审这段用户服务API的设计，检查其路径命名、参数和响应格式是否与我们的订单服务API范例保持一致。’ 它会分析你提供的API定义，对比预设的范例，指出诸如‘用户查询接口使用了`/getUser`而非RESTful风格的`/users`’等不一致点，并给出修改建议。
介绍
api-review Skill 专注于解决API接口设计评审中的一致性问题。在开发微服务或前后端协作时，不同开发者设计的API在命名、参数、响应格式上容易出现不一致，导致对接困难和维护成本增加。该Skill通过分析API设计，检查其是否符合团队规范或行业最佳实践，帮助团队建立统一的API风格。
使用时，您可以将API设计文档、代码片段或OpenAPI规范提供给该Skill。它会自动分析接口的命名（如路径、方法）、参数结构（如查询参数、请求体）、响应格式（如状态码、数据字段）等关键元素，并与预设的范例或规则进行比对，输出详细的评估报告，指出不一致之处和改进建议。
该Skill特别适合后端开发、全栈开发和运维开发工程师，尤其是在团队协作开发、重构遗留系统或制定API设计规范时使用。项目经理和产品经理也可以用它来确保技术交付物符合预期的接口标准。
建议在API设计初期或代码评审阶段使用此Skill，以便尽早发现问题。请注意，它主要评估设计层面的一致性，对于API的业务逻辑正确性、性能或安全性，仍需结合其他工具和人工评审进行综合判断。
核心特点
与一般代码质量检查工具不同，它专门聚焦于API接口层面的设计一致性和规范性评估，并能与预设的范例（exemplar）进行对齐检查，确保API风格统一。
注意事项
不适合评估API的业务逻辑实现、性能瓶颈或深层次的安全漏洞。
常见问题
api-review能检查哪些API设计问题？
主要检查API路径命名、HTTP方法使用、请求/响应参数结构、状态码使用、数据格式等设计的一致性问题。
它支持哪些API描述格式？
通常支持OpenAPI/Swagger规范、代码中的接口定义或结构化的API设计文档。
给 AI 助手的安装指引
如果你的 AI 编程助手（Claude Code、Cursor、TRAE 等）能看到这个页面，把下面这段发给它即可自动完成安装：
请访问 https://321skill.com/skills/api-review-x-2/raw/index.md 读取 api-review 的原始 Skill 定义（Markdown 格式），按其中说明在我的环境里完成安装和配置。
AI 可直接读取的原始 Markdown 地址：/skills/api-review-x-2/raw/index.md（查看排版版本）