api-review
评估API接口设计，确保一致性与规范性
安装使用
复制下面这段提示词发给你的 AI（Claude / Cursor / TRAE / Codex / WorkBuddy 等），它会自动帮你完成安装：
帮我安装这个 AI Skill：api-review。 它的用途是：评估API接口设计，确保一致性与规范性 完整的 Skill 内容见：https://321skill.com/skills/api-review-x-5/raw/index.md 请读取该页面内容，如果是 SKILL.md 格式直接安装，如果是 README 提炼核心 prompt 后安装。
提示词包含完整的 Skill 内容链接，AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。
使用示例
'请评估以下用户管理API的设计：GET /api/v1/getUserList, POST /api/v1/addNewUser，响应格式是{code: 200, data: {...}}'，它会分析资源命名、HTTP方法使用、版本管理和响应结构，指出不符合RESTful规范的地方，并建议改为GET /api/v1/users和POST /api/v1/users，以及使用标准化的错误响应体。
介绍
这个Skill专门用于评估API接口的表面设计、一致性和与最佳实践的契合度。它帮助开发者在设计或审查API时，快速识别设计缺陷、命名不一致、参数冗余等问题，确保API易于理解、使用和维护。
使用时，你可以将API的接口定义、参数说明、响应格式等信息提供给AI，它会基于行业标准和最佳实践（如RESTful原则、命名规范、错误处理等）进行分析，并给出具体的评估报告和改进建议。
它非常适合后端开发、全栈开发和API设计师，尤其是在团队协作开发、重构遗留API或制定API设计规范时使用。项目经理和文档工程师也能借助它来确保API文档的质量和一致性。
建议在API设计初期或代码评审阶段使用此Skill，以便尽早发现问题。请注意，它主要评估设计层面，不涉及具体的业务逻辑实现或性能测试，因此需要结合其他工具进行完整的API验证。
核心特点
专注于API设计的静态评估，而非运行时测试或性能分析。它能对比现有API与行业典范（如Google、Microsoft的API设计指南），提供具体的一致性检查和改进建议，帮助团队建立统一的API设计语言。
注意事项
不适用于评估API的实际运行性能、安全漏洞或具体的业务逻辑正确性。
常见问题
api-review能检查哪些API设计问题？
可以检查命名不一致、HTTP方法误用、资源结构不合理、错误响应格式不规范、版本管理策略缺失等设计问题。
它支持哪些API描述格式？
主要支持OpenAPI/Swagger等标准格式，也支持通过自然语言描述API结构进行评估。
给 AI 助手的安装指引
如果你的 AI 编程助手（Claude Code、Cursor、TRAE 等）能看到这个页面，把下面这段发给它即可自动完成安装：
请访问 https://321skill.com/skills/api-review-x-5/raw/index.md 读取 api-review 的原始 Skill 定义（Markdown 格式），按其中说明在我的环境里完成安装和配置。
AI 可直接读取的原始 Markdown 地址：/skills/api-review-x-5/raw/index.md（查看排版版本）