# API 接口文档: {{moduleName}}

> 模块: {{module}} | 实体: {{Entity}} | 基础路径: `/api/{{entity}}`

---

## 接口概览

| Method | Path | 描述 | 认证 |
|--------|------|------|------|
| GET | `/api/{{entity}}` | 分页查询 | 需要 |
| GET | `/api/{{entity}}/:id` | 详情查询 | 需要 |
| POST | `/api/{{entity}}` | 新增 | 需要 |
| PUT | `/api/{{entity}}/:id` | 修改 | 需要 |
| DELETE | `/api/{{entity}}/:id` | 删除 | 需要 |

---

## 1. 分页查询

**请求**: `GET /api/{{entity}}`

| 参数 | 类型 | 必填 | 说明 |
|------|------|------|------|
| page | number | 否 | 页码，默认 1 |
| size | number | 否 | 每页条数，默认 10 |
| keyword | string | 否 | 关键词搜索 |

**响应示例**:
```json
{
  "code": 200,
  "message": "success",
  "data": {
    "records": [
      {
        "id": 1,
        "name": "示例数据",
        "createTime": "2025-01-01 00:00:00"
      }
    ],
    "total": 100,
    "page": 1,
    "size": 10
  }
}
```

---

## 2. 详情查询

**请求**: `GET /api/{{entity}}/:id`

| 参数 | 类型 | 必填 | 说明 |
|------|------|------|------|
| id | number | 是 | 记录 ID（路径参数） |

**响应示例**:
```json
{
  "code": 200,
  "message": "success",
  "data": {
    "id": 1,
    "name": "示例数据",
    "createTime": "2025-01-01 00:00:00",
    "updateTime": "2025-01-01 00:00:00"
  }
}
```

---

## 3. 新增

**请求**: `POST /api/{{entity}}`

**请求体**:
```json
{
  "name": "新增数据"
}
```

**响应示例**:
```json
{
  "code": 200,
  "message": "success",
  "data": 1
}
```

---

## 4. 修改

**请求**: `PUT /api/{{entity}}/:id`

**请求体**:
```json
{
  "name": "修改后的数据"
}
```

**响应示例**:
```json
{
  "code": 200,
  "message": "success",
  "data": null
}
```

---

## 5. 删除

**请求**: `DELETE /api/{{entity}}/:id`

| 参数 | 类型 | 必填 | 说明 |
|------|------|------|------|
| id | number | 是 | 记录 ID（路径参数） |

**响应示例**:
```json
{
  "code": 200,
  "message": "success",
  "data": null
}
```

---

## 通用错误码

| 错误码 | 说明 | 示例 |
|--------|------|------|
| 400 | 请求参数错误 | `{"code": 400, "message": "参数校验失败"}` |
| 401 | 未认证 | `{"code": 401, "message": "请先登录"}` |
| 403 | 无权限 | `{"code": 403, "message": "权限不足"}` |
| 404 | 资源不存在 | `{"code": 404, "message": "记录不存在"}` |
| 500 | 服务器内部错误 | `{"code": 500, "message": "系统异常"}` |