用途:该技能聚焦 REST 与 GraphQL API 的设计原则,目标是构建直观、可扩展、易维护、对开发者友好的 API,并使其具备长期可用性。
适用场景:设计新的 REST 或 GraphQL API;为提升易用性重构既有 API;为团队建立 API 设计标准;在实现前评审 API 规范;在 API 范式之间迁移(如 REST 到 GraphQL);编写对开发者友好的 API 文档;针对移动端、第三方集成等特定场景优化 API。
不适用场景:只需要某个具体框架的实现指导;仅做基础设施工作且不涉及 API 契约;无法更改或版本化公开接口。
主要流程:先明确消费者、用例与约束;再选择 API 风格并建模资源或类型;随后规定错误、版本化、分页与认证策略;最后用示例验证并检查一致性。
资源:resources/implementation-playbook.md 提供详细模式、检查清单与模板;知识模块为 implementation-playbook。
限制:资料未提供具体收费、价格、平台支持范围或量化效果信息。