api-design - 设计一致且可用于生产的 API
设计 REST、GraphQL、gRPC 和 WebSocket API，涵盖一致的模式、版本管理、错误规范、分页和开发者体验。
标签
更新于: 2026-09-30能力
典型输入
典型输出
该技能可以做什么
- 设计 REST API
- 设计 GraphQL 模式
- 设计 gRPC 契约
- 设计 WebSocket API
- 选择 API 风格
- 定义端点结构
- 组织请求响应
- 统一 API 错误
- 设计分页模式
- 规划 API 版本
- 生成 OpenAPI 规范
输入
- 调用方信息
- 领域资源
- 资源操作
- 读写模式
- 延迟约束
- 载荷大小约束
- 版本管理需求
输出
- API 端点定义
- 请求响应模式
- GraphQL 模式
- Protocol Buffer 文件
- OpenAPI 规范
- 错误响应规范
- 分页规范
- 版本管理策略