API Design Skill - 设计一致且面向消费者的 API
设计 REST API,涵盖清晰的资源、契约、版本控制、分页、错误处理、缓存和速率限制。
标签
更新于: 2026-10-01能力
典型输入
典型输出
该技能可以做什么
- 命名 REST 资源
- 定义 HTTP 方法
- 选择状态码
- 创建 OpenAPI 契约
- 规划 API 版本
- 设计分页模式
- 构建错误响应
- 设计请求响应
- 配置缓存策略
- 定义速率限制
输入
- API 需求
- 消费者反馈
- 资源模型
- 现有 API 约定
输出
- API 设计指导
- OpenAPI 契约
- 资源命名规则
- 版本规划
- 分页设计
- 错误响应结构
- 缓存配置
- 速率限制设计
