# 黑名单管理

> 模块标识：blacklist  |  接口数量：5

## 1. 获取黑名单列表
**方法**：	GET

**路径**：				/api/blacklists

**功能说明**：
分页获取黑名单列表

### 请求参数
```json
{
  "query": [
    {
      "name": "pageNum",
      "type": "number",
      "required": false,
      "description": "页码，默认1"
    },
    {
      "name": "pageSize",
      "type": "number",
      "required": false,
      "description": "每页数量，默认10"
    },
    {
      "name": "userId",
      "type": "string",
      "required": false,
      "description": "按用户筛选"
    }
  ]
}
```

### 响应示例
```json
{
  "success": {
    "code": "0000",
    "message": "获取成功",
    "data": {
      "list": [
        {
          "id": 1,
          "userId": "USER0002",
          "reason": "恶意操作",
          "createTime": "2025-01-01T10:00:00.000Z"
        }
      ],
      "total": 100,
      "pageNum": 1,
      "pageSize": 10
    }
  }
}
```


## 2. 获取黑名单详情
**方法**：	GET

**路径**：				/api/blacklists/{id}

**功能说明**：
根据黑名单ID获取详细信息

### 请求参数
```json
{
  "path": [
    {
      "name": "id",
      "type": "string",
      "required": true,
      "description": "黑名单ID"
    }
  ]
}
```

### 响应示例
```json
{
  "success": {
    "code": "0000",
    "message": "获取成功",
    "data": {
      "id": 1,
      "userId": "USER0002",
      "reason": "恶意操作",
      "createTime": "2025-01-01T10:00:00.000Z"
    }
  },
  "failure": {
    "code": "4040",
    "message": "黑名单不存在",
    "data": null
  }
}
```


## 3. 创建黑名单
**方法**：	POST

**路径**：				/api/blacklists

**功能说明**：
创建新的黑名单

### 请求参数
```json
{
  "body": {
    "userId": "string｜必填，用户ID",
    "reason": "string｜可选，加入黑名单原因"
  }
}
```

### 响应示例
```json
{
  "success": {
    "code": "0000",
    "message": "创建黑名单成功",
    "data": {
      "id": 1,
      "userId": "USER0002",
      "reason": "恶意操作",
      "createTime": "2025-01-01T10:00:00.000Z"
    }
  },
  "failure": {
    "code": "4000",
    "message": "创建黑名单失败",
    "data": null
  }
}
```


## 4. 更新黑名单
**方法**：	PUT

**路径**：				/api/blacklists/{id}

**功能说明**：
更新指定黑名单的信息

### 请求参数
```json
{
  "body": {
    "userId": "string｜必填，用户ID",
    "reason": "string｜可选，加入黑名单原因"
  },
  "path": [
    {
      "name": "id",
      "type": "string",
      "required": true,
      "description": "黑名单ID"
    }
  ]
}
```

### 响应示例
```json
{
  "success": {
    "code": "0000",
    "message": "更新黑名单成功",
    "data": {
      "id": 1,
      "userId": "USER0002",
      "reason": "恶意操作",
      "createTime": "2025-01-01T10:00:00.000Z"
    }
  },
  "failure": {
    "code": "4000",
    "message": "更新黑名单失败",
    "data": null
  }
}
```


## 5. 删除黑名单
**方法**：	DELETE

**路径**：				/api/blacklists/{id}

**功能说明**：
删除指定的黑名单

### 请求参数
```json
{
  "path": [
    {
      "name": "id",
      "type": "string",
      "required": true,
      "description": "黑名单ID"
    }
  ]
}
```

### 响应示例
```json
{
  "success": {
    "code": "0000",
    "message": "删除黑名单成功",
    "data": {
      "result": true
    }
  },
  "failure": {
    "code": "4000",
    "message": "删除黑名单失败",
    "data": null
  }
}
```