api-review
评估API接口设计的合理性、一致性与最佳实践对齐度
安装使用
复制下面这段提示词发给你的 AI（Claude / Cursor / TRAE / Codex / WorkBuddy 等），它会自动帮你完成安装：
帮我安装这个 AI Skill：api-review。 它的用途是：评估API接口设计的合理性、一致性与最佳实践对齐度 完整的 Skill 内容见：https://321skill.com/skills/api-review-x/raw/index.md 请读取该页面内容，如果是 SKILL.md 格式直接安装，如果是 README 提炼核心 prompt 后安装。
提示词包含完整的 Skill 内容链接，AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。
使用示例
‘请帮我评审这个用户创建接口的设计：POST /api/v1/user/create，请求体是{“name”: string, “age”: number}，成功返回200和用户ID。’ 它会分析该接口的URL路径设计、HTTP方法选用、请求/响应体结构，并指出‘/create’后缀冗余、建议使用POST /api/v1/users，以及响应体应包裹在标准数据结构中等改进点。
介绍
api-review Skill 旨在解决开发者在设计或评审API接口时，难以系统化评估其设计质量、一致性和是否符合行业最佳实践的问题。它通过预设的评估框架，帮助开发者发现API设计中的潜在缺陷，如命名不一致、参数设计不合理、响应结构不规范等，从而提升API的可用性和可维护性。
使用该Skill时，你只需提供待评估的API接口定义（例如OpenAPI/Swagger文档、代码片段或自然语言描述），AI Agent便会从多个维度进行分析，并给出具体的改进建议和理由。整个过程无需复杂的配置，交互自然流畅。
该Skill非常适合后端开发、全栈开发和负责技术架构的工程师使用。他们在设计新API、重构旧接口或进行代码评审时，可以利用此工具获得客观、专业的第二意见，确保API设计的高标准。
建议在API设计的早期或评审阶段使用，以便及早发现问题。对于高度定制化或非RESTful风格的API，评估标准可能需要结合具体业务上下文进行微调。
核心特点
与通用代码审查工具不同，它专注于API接口层面的设计评审，提供针对RESTful/GraphQL等API的专用评估维度，如资源命名、HTTP方法使用、状态码一致性等，而非泛泛的代码风格或语法检查。
注意事项
不适合评估API内部的业务逻辑实现正确性或性能瓶颈，主要关注接口契约的设计层面。
常见问题
它能评估哪些格式的API定义？
支持OpenAPI/Swagger规范文档、代码中的接口定义片段，或用自然语言描述的API设计。
评估报告包含哪些内容？
通常包括一致性检查、命名规范、HTTP语义正确性、错误处理、版本管理以及与已知最佳实践的对比分析。
给 AI 助手的安装指引
如果你的 AI 编程助手（Claude Code、Cursor、TRAE 等）能看到这个页面，把下面这段发给它即可自动完成安装：
请访问 https://321skill.com/skills/api-review-x/raw/index.md 读取 api-review 的原始 Skill 定义（Markdown 格式），按其中说明在我的环境里完成安装和配置。
AI 可直接读取的原始 Markdown 地址：/skills/api-review-x/raw/index.md（查看排版版本）