API接口设计

设计RESTful或GraphQL API

提示词

请为[资源/功能]设计一套[RESTful/GraphQL] API：

资源描述：[描述资源及其关系]

要求：
1. 遵循RESTful规范（如选REST）
2. 列出所有端点：HTTP方法、路径、描述
3. 请求参数和请求体结构
4. 响应格式（成功和错误）
5. 状态码使用规范
6. 认证鉴权方式
7. 分页/过滤/排序方案
8. 速率限制建议

输出格式：用表格和示例JSON呈现。

示例输出

用户管理API

| 方法 | 路径 | 描述 | |------|------|------| | GET | /api/users | 获取用户列表（分页）| | POST | /api/users | 创建用户 | | GET | /api/users/:id | 获取单个用户 | | PUT | /api/users/:id | 更新用户 | | DELETE | /api/users/:id | 删除用户 |

GET /api/users

查询参数：page(默认1), limit(默认20), sort, role

响应：

{
  "data": [...],
  "pagination": {
    "page": 1,
    "total": 100,
    "hasMore": true
  }
}