{
  "module": "黑名单管理",
  "moduleKey": "blacklist",
  "apiCount": 5,
  "apis": [
    {
      "title": "获取黑名单列表",
      "method": "GET",
      "path": "/api/blacklists",
      "description": "分页获取黑名单列表",
      "requestParams": {
        "query": [
          {
            "name": "pageNum",
            "type": "number",
            "required": false,
            "description": "页码，默认1"
          },
          {
            "name": "pageSize",
            "type": "number",
            "required": false,
            "description": "每页数量，默认10"
          },
          {
            "name": "userId",
            "type": "string",
            "required": false,
            "description": "按用户筛选"
          }
        ]
      },
      "responseExample": {
        "success": {
          "code": "0000",
          "message": "获取成功",
          "data": {
            "list": [
              {
                "id": 1,
                "userId": "USER0002",
                "reason": "恶意操作",
                "createTime": "2025-01-01T10:00:00.000Z"
              }
            ],
            "total": 100,
            "pageNum": 1,
            "pageSize": 10
          }
        }
      }
    },
    {
      "title": "获取黑名单详情",
      "method": "GET",
      "path": "/api/blacklists/{id}",
      "description": "根据黑名单ID获取详细信息",
      "requestParams": {
        "path": [
          {
            "name": "id",
            "type": "string",
            "required": true,
            "description": "黑名单ID"
          }
        ]
      },
      "responseExample": {
        "success": {
          "code": "0000",
          "message": "获取成功",
          "data": {
            "id": 1,
            "userId": "USER0002",
            "reason": "恶意操作",
            "createTime": "2025-01-01T10:00:00.000Z"
          }
        },
        "failure": {
          "code": "4040",
          "message": "黑名单不存在",
          "data": null
        }
      }
    },
    {
      "title": "创建黑名单",
      "method": "POST",
      "path": "/api/blacklists",
      "description": "创建新的黑名单",
      "requestParams": {
        "body": {
          "userId": "string｜必填，用户ID",
          "reason": "string｜可选，加入黑名单原因"
        }
      },
      "responseExample": {
        "success": {
          "code": "0000",
          "message": "创建黑名单成功",
          "data": {
            "id": 1,
            "userId": "USER0002",
            "reason": "恶意操作",
            "createTime": "2025-01-01T10:00:00.000Z"
          }
        },
        "failure": {
          "code": "4000",
          "message": "创建黑名单失败",
          "data": null
        }
      }
    },
    {
      "title": "更新黑名单",
      "method": "PUT",
      "path": "/api/blacklists/{id}",
      "description": "更新指定黑名单的信息",
      "requestParams": {
        "body": {
          "userId": "string｜必填，用户ID",
          "reason": "string｜可选，加入黑名单原因"
        },
        "path": [
          {
            "name": "id",
            "type": "string",
            "required": true,
            "description": "黑名单ID"
          }
        ]
      },
      "responseExample": {
        "success": {
          "code": "0000",
          "message": "更新黑名单成功",
          "data": {
            "id": 1,
            "userId": "USER0002",
            "reason": "恶意操作",
            "createTime": "2025-01-01T10:00:00.000Z"
          }
        },
        "failure": {
          "code": "4000",
          "message": "更新黑名单失败",
          "data": null
        }
      }
    },
    {
      "title": "删除黑名单",
      "method": "DELETE",
      "path": "/api/blacklists/{id}",
      "description": "删除指定的黑名单",
      "requestParams": {
        "path": [
          {
            "name": "id",
            "type": "string",
            "required": true,
            "description": "黑名单ID"
          }
        ]
      },
      "responseExample": {
        "success": {
          "code": "0000",
          "message": "删除黑名单成功",
          "data": {
            "result": true
          }
        },
        "failure": {
          "code": "4000",
          "message": "删除黑名单失败",
          "data": null
        }
      }
    }
  ]
}