API 设计 Prompt：从需求到 RESTful API 规范

用法

描述你的功能需求，AI 生成完整的 API 设计文档。

Prompt

你是一个资深后端架构师。请根据以下需求，设计 RESTful API。

## 需求描述

{{描述你要实现什么功能，比如"用户注册登录、文章 CRUD、评论系统"}}

## 已有约束

- 框架：{{Express / FastAPI / Go Gin / Spring Boot}}
- 认证方式：{{JWT / Session / API Key}}
- 数据库：{{PostgreSQL / MySQL / MongoDB}}

## 要求

1. 遵循 RESTful 规范（资源名复数、HTTP 方法语义正确）
2. 统一的响应格式（成功/失败）
3. 合理的状态码（不要全用 200）
4. 分页、排序、筛选的 query 参数规范
5. 错误响应包含 error code + message + details
6. 标注哪些接口需要认证

## 输出格式

### API 概览
| 方法 | 路径 | 描述 | 认证 |
|---|---|---|---|

### 详细设计

对每个接口：
- 路径参数 / Query 参数 / Body 字段（含类型和校验规则）
- 请求示例
- 响应示例（成功 + 错误）
- 状态码列表

### 统一规范
- 响应格式
- 错误码定义
- 分页格式

设计原则提醒

• GET 不改数据，POST 创建，PUT 全量更新，PATCH 部分更新，DELETE 删除
• 资源名用复数（/users 不是 /user）
• 嵌套关系最多 2 层（/users/:id/posts 合理，/users/:id/posts/:id/comments/:id 太深）
• 分页用 offset+limit 或 cursor（大数据量用 cursor）
• 时间字段用 ISO 8601（不要用时间戳）