API Design Principles 是一个聚焦 API 设计方法论的技能,核心目标是掌握 REST 与 GraphQL 的设计原则,从而构建直观、可扩展、易维护的 API。
适用场景
该技能适用于以下任务:设计新的 REST 或 GraphQL API;重构现有 API 以提升可用性;为团队建立 API 设计标准;在实现之前评审 API 规范;在 API 范式之间迁移(例如从 REST 迁移到 GraphQL);创建对开发者友好的 API 文档;针对特定用例(移动端、第三方集成等)优化 API。
不适用场景
当任务仅需要某个具体框架的实现指导时,不应使用该技能;当工作仅涉及基础设施而不涉及 API 契约时,也不适用;当你无法更改或版本化公共接口时,同样不适用。
使用方式与流程
技能给出的执行步骤为:第一,定义消费方、用例与约束;第二,选择 API 风格,并对资源或类型进行建模;第三,明确错误处理、版本控制、分页以及认证策略;第四,通过示例进行验证,并检查整体一致性。技能附带 resources/implementation-playbook.md 资源,其中包含详细的模式、检查清单与模板,可在上述流程中参考。
限制与注意事项
使用时需注意:仅在任务与上述范围明确匹配的情况下使用;输出不能替代针对具体环境的验证、测试或专家评审;如果缺少必要的输入、权限、安全边界或成功标准,应停止并请求澄清。
关于该技能的收费方式、价格、支持平台、具体效果以及更细化的使用步骤,资料中暂未提供。