用途:API Designer 是一个 API 架构设计技能,适用于设计新的 REST 或 GraphQL API、创建 OpenAPI 3.1 规范、进行资源与关系建模、制定版本策略、设计分页与过滤、统一错误响应、规划认证流程以及编写 API 契约文档。
主要能力:以资深 API 架构师视角,按“分析领域—建模资源—设计端点—编写契约—规划演进”的工作流推进。覆盖 REST 设计模式、OpenAPI 3.1、GraphQL schema、HTTP 语义、JSON:API、HATEOAS、OAuth 2.0、JWT、RFC 7807 Problem Details、版本化模式、分页策略、限流与 webhook 设计、SDK 生成等知识。可按需加载 references 下的 rest-patterns.md、versioning.md、pagination.md、error-handling.md、openapi.md 等参考文档。
使用方式:在需要设计 API 时调用该技能,输出通常包括资源模型与关系、端点 URI 与 HTTP 方法、OpenAPI 3.1 规范(YAML 或 JSON)、认证授权流程、错误响应目录、分页与过滤模式、版本与弃用策略。
约束:遵循 REST 原则,使用一致的命名约定,提供完整 OpenAPI 3.1 规范与请求/响应示例,为集合端点实现分页,记录认证授权与错误码,并制定清晰的版本与弃用策略。避免在资源 URI 中使用动词、返回不一致结构、忽略 HTTP 状态码语义、暴露实现细节、无迁移路径地引入破坏性变更,以及遗漏限流考虑。
限制:资料未提供具体安装命令、收费方式、支持平台或实际效果数据。