{
  "openapi": "3.0.3",
  "info": {
    "title": "黑名单管理",
    "version": "1.0.0",
    "description": "黑名单管理相关接口文档"
  },
  "paths": {
    "/api/blacklists": {
      "get": {
        "summary": "获取黑名单列表",
        "description": "分页获取黑名单列表",
        "parameters": [
          {
            "name": "pageNum",
            "in": "query",
            "required": false,
            "schema": {
              "type": "number"
            },
            "description": "页码，默认1"
          },
          {
            "name": "pageSize",
            "in": "query",
            "required": false,
            "schema": {
              "type": "number"
            },
            "description": "每页数量，默认10"
          },
          {
            "name": "userId",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "description": "按用户筛选"
          }
        ],
        "responses": {
          "200": {
            "description": "成功响应",
            "content": {
              "application/json": {
                "example": {
                  "success": {
                    "code": "0000",
                    "message": "获取成功",
                    "data": {
                      "list": [
                        {
                          "id": 1,
                          "userId": "USER0002",
                          "reason": "恶意操作",
                          "createTime": "2025-01-01T10:00:00.000Z"
                        }
                      ],
                      "total": 100,
                      "pageNum": 1,
                      "pageSize": 10
                    }
                  }
                }
              }
            }
          }
        }
      },
      "post": {
        "summary": "创建黑名单",
        "description": "创建新的黑名单",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "userId": {
                    "type": "string",
                    "description": "string｜必填，用户ID"
                  },
                  "reason": {
                    "type": "string",
                    "description": "string｜可选，加入黑名单原因"
                  }
                },
                "required": [
                  "userId"
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "成功响应",
            "content": {
              "application/json": {
                "example": {
                  "success": {
                    "code": "0000",
                    "message": "创建黑名单成功",
                    "data": {
                      "id": 1,
                      "userId": "USER0002",
                      "reason": "恶意操作",
                      "createTime": "2025-01-01T10:00:00.000Z"
                    }
                  },
                  "failure": {
                    "code": "4000",
                    "message": "创建黑名单失败",
                    "data": null
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/blacklists/{id}": {
      "get": {
        "summary": "获取黑名单详情",
        "description": "根据黑名单ID获取详细信息",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "黑名单ID"
          }
        ],
        "responses": {
          "200": {
            "description": "成功响应",
            "content": {
              "application/json": {
                "example": {
                  "success": {
                    "code": "0000",
                    "message": "获取成功",
                    "data": {
                      "id": 1,
                      "userId": "USER0002",
                      "reason": "恶意操作",
                      "createTime": "2025-01-01T10:00:00.000Z"
                    }
                  },
                  "failure": {
                    "code": "4040",
                    "message": "黑名单不存在",
                    "data": null
                  }
                }
              }
            }
          }
        }
      },
      "put": {
        "summary": "更新黑名单",
        "description": "更新指定黑名单的信息",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "黑名单ID"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "userId": {
                    "type": "string",
                    "description": "string｜必填，用户ID"
                  },
                  "reason": {
                    "type": "string",
                    "description": "string｜可选，加入黑名单原因"
                  }
                },
                "required": [
                  "userId"
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "成功响应",
            "content": {
              "application/json": {
                "example": {
                  "success": {
                    "code": "0000",
                    "message": "更新黑名单成功",
                    "data": {
                      "id": 1,
                      "userId": "USER0002",
                      "reason": "恶意操作",
                      "createTime": "2025-01-01T10:00:00.000Z"
                    }
                  },
                  "failure": {
                    "code": "4000",
                    "message": "更新黑名单失败",
                    "data": null
                  }
                }
              }
            }
          }
        }
      },
      "delete": {
        "summary": "删除黑名单",
        "description": "删除指定的黑名单",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "黑名单ID"
          }
        ],
        "responses": {
          "200": {
            "description": "成功响应",
            "content": {
              "application/json": {
                "example": {
                  "success": {
                    "code": "0000",
                    "message": "删除黑名单成功",
                    "data": {
                      "result": true
                    }
                  },
                  "failure": {
                    "code": "4000",
                    "message": "删除黑名单失败",
                    "data": null
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}