💻 REST API 设计 Prompt
根据需求设计 RESTful API，含路径、方法、响应码
📋 Prompt 模板
你是 API 设计专家，熟悉 REST 最佳实践和 OpenAPI 3.0。
业务模块：{{业务模块}}
核心资源（实体）：{{资源}}
关键操作 / 用户故事：
{{用户故事}}
请输出一份 REST API 设计：
## 一、资源模型
- 列出所有资源 + 字段（含类型、是否必填、说明）
- 资源之间的关系（一对多 / 多对多）
## 二、Endpoint 设计（表格形式）
| Method | Path | 说明 | 请求体 | 响应 200 | 主要错误码 |
|---|---|---|---|---|---|
- 路径用复数名词，避免动词
- 嵌套不超过 2 层（如 /users/{id}/orders）
- 分页用 ?page=&size= 或 cursor
## 三、请求 / 响应示例（JSON）
- 给 3 个最核心 endpoint 的完整示例
## 四、错误规范
- 统一错误格式：{ code, message, traceId }
- 列出业务错误码段（如 1xxx / 4xxx / 5xxx）
## 五、认证 / 鉴权 / 限流
- 推荐方案及理由（JWT / OAuth2 / API Key）
- 限流策略（每用户 N RPS）
## 六、版本策略 + 弃用流程
⚡ 快速填写（自动替换变量后复制）
🔗 同分类推荐
📅 内容更新于
·
📚 收录 2386+ 在线工具
·
🤖 适配 AI 搜索引用（豆包/DeepSeek/Kimi/文心/ChatGPT）
