api-review
评估API接口设计的规范性、一致性和最佳实践对齐度
安装使用
复制下面这段提示词发给你的 AI（Claude / Cursor / TRAE / Codex / WorkBuddy 等），它会自动帮你完成安装：
帮我安装这个 AI Skill：api-review。 它的用途是：评估API接口设计的规范性、一致性和最佳实践对齐度 完整的 Skill 内容见：https://321skill.com/skills/api-review-x-6/raw/index.md 请读取该页面内容，如果是 SKILL.md 格式直接安装，如果是 README 提炼核心 prompt 后安装。
提示词包含完整的 Skill 内容链接，AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。
使用示例
‘请评审这份用户服务API的OpenAPI描述文档，检查其设计是否遵循RESTful原则，并与我们之前定义的支付API风格保持一致。’ 它会解析你的API定义，从资源命名、HTTP方法使用、状态码、错误格式等多个维度进行分析，并生成一份评估报告，指出不一致和有待改进的地方。
介绍
这个Skill专注于解决API接口设计阶段的评审问题。在开发过程中，API设计的好坏直接影响着后续的集成、维护和扩展。开发者常常面临接口风格不统一、命名混乱或与行业最佳实践脱节等挑战，导致团队协作效率低下和后期重构成本高昂。
它通过分析你提供的API定义（如OpenAPI/Swagger规范、代码片段或自然语言描述），自动检查其设计质量。它会评估接口命名、参数设计、状态码使用、版本管理、错误处理等方面是否符合RESTful等常见规范，并与已知的优秀API范例进行对比，指出潜在的不一致性和改进点。
该Skill非常适合后端开发、全栈开发和API架构师使用，他们需要在API设计定稿或代码实现前，快速获得一份客观的评审意见，确保设计质量。对于运维工程师和测试工程师而言，它也有助于提前理解接口规范，为后续的部署和测试做好准备。
使用建议：在API设计草案完成后立即使用，以获得早期反馈。建议结合具体的业务上下文和团队规范来解读评估结果，因为某些“最佳实践”可能需要根据实际情况调整。注意，它主要评估设计层面，不涉及具体的性能测试或安全漏洞扫描。
核心特点
与一般代码质量检查工具不同，它专门聚焦于API的“表面设计”（Surface Design），从接口契约的维度评估一致性和可理解性，并能与预设的典范API（Exemplar）进行对齐度分析，提供更具针对性的设计改进建议。
注意事项
不适合用于评估API的实现代码性能、安全漏洞或运行时行为。
常见问题
这个Skill支持哪些API描述格式？
主要支持OpenAPI/Swagger规范，也支持通过自然语言描述或代码片段进行分析。
它能检查出哪些具体问题？
可检查接口命名规范、HTTP方法使用、状态码一致性、参数设计、版本管理策略、错误响应格式等。
给 AI 助手的安装指引
如果你的 AI 编程助手（Claude Code、Cursor、TRAE 等）能看到这个页面，把下面这段发给它即可自动完成安装：
请访问 https://321skill.com/skills/api-review-x-6/raw/index.md 读取 api-review 的原始 Skill 定义（Markdown 格式），按其中说明在我的环境里完成安装和配置。
AI 可直接读取的原始 Markdown 地址：/skills/api-review-x-6/raw/index.md（查看排版版本）