{
  "module": "权限管理",
  "moduleKey": "permission",
  "apiCount": 5,
  "apis": [
    {
      "title": "获取权限列表",
      "method": "GET",
      "path": "/api/permissions",
      "description": "分页获取权限列表",
      "requestParams": {
        "query": [
          {
            "name": "pageNum",
            "type": "number",
            "required": false,
            "description": "页码，默认1"
          },
          {
            "name": "pageSize",
            "type": "number",
            "required": false,
            "description": "每页数量，默认10"
          },
          {
            "name": "name",
            "type": "string",
            "required": false,
            "description": "权限名称关键词"
          },
          {
            "name": "code",
            "type": "string",
            "required": false,
            "description": "权限编码"
          }
        ]
      },
      "responseExample": {
        "success": {
          "code": "0000",
          "message": "获取成功",
          "data": {
            "list": [
              {
                "id": 1,
                "code": "PERM0001",
                "name": "用户管理",
                "type": "menu",
                "status": 1,
                "createTime": "2025-01-01T10:00:00.000Z"
              }
            ],
            "total": 100,
            "pageNum": 1,
            "pageSize": 10
          }
        }
      }
    },
    {
      "title": "获取权限详情",
      "method": "GET",
      "path": "/api/permissions/{id}",
      "description": "根据权限ID获取权限详细信息",
      "requestParams": {
        "path": [
          {
            "name": "id",
            "type": "string",
            "required": true,
            "description": "权限ID"
          }
        ]
      },
      "responseExample": {
        "success": {
          "code": "0000",
          "message": "获取成功",
          "data": {
            "id": 1,
            "code": "PERM0001",
            "name": "用户管理",
            "type": "menu",
            "status": 1,
            "createTime": "2025-01-01T10:00:00.000Z"
          }
        },
        "failure": {
          "code": "4040",
          "message": "权限不存在",
          "data": null
        }
      }
    },
    {
      "title": "创建权限",
      "method": "POST",
      "path": "/api/permissions",
      "description": "创建新的权限",
      "requestParams": {
        "body": {
          "name": "string｜必填，权限名称",
          "code": "string｜必填，权限编码，唯一",
          "type": "string｜可选，权限类型，例如menu/button",
          "status": "number｜可选，状态：1-启用，0-禁用"
        }
      },
      "responseExample": {
        "success": {
          "code": "0000",
          "message": "创建权限成功",
          "data": {
            "id": 1,
            "code": "PERM0001",
            "name": "用户管理",
            "type": "menu",
            "status": 1,
            "createTime": "2025-01-01T10:00:00.000Z"
          }
        },
        "failure": {
          "code": "4000",
          "message": "创建权限失败",
          "data": null
        }
      }
    },
    {
      "title": "更新权限",
      "method": "PUT",
      "path": "/api/permissions/{id}",
      "description": "更新指定权限的信息",
      "requestParams": {
        "body": {
          "name": "string｜必填，权限名称",
          "code": "string｜必填，权限编码，唯一",
          "type": "string｜可选，权限类型，例如menu/button",
          "status": "number｜可选，状态：1-启用，0-禁用"
        },
        "path": [
          {
            "name": "id",
            "type": "string",
            "required": true,
            "description": "权限ID"
          }
        ]
      },
      "responseExample": {
        "success": {
          "code": "0000",
          "message": "更新权限成功",
          "data": {
            "id": 1,
            "code": "PERM0001",
            "name": "用户管理",
            "type": "menu",
            "status": 1,
            "createTime": "2025-01-01T10:00:00.000Z"
          }
        },
        "failure": {
          "code": "4000",
          "message": "更新权限失败",
          "data": null
        }
      }
    },
    {
      "title": "删除权限",
      "method": "DELETE",
      "path": "/api/permissions/{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
        }
      }
    }
  ]
}