{
  "module": "角色管理",
  "moduleKey": "role",
  "apiCount": 7,
  "apis": [
    {
      "title": "获取角色列表",
      "method": "GET",
      "path": "/api/roles",
      "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": "ROLE0001",
                "name": "系统管理员",
                "status": 1,
                "permissions": [
                  "PERM0001"
                ],
                "resources": [
                  "RES0001"
                ]
              }
            ],
            "total": 100,
            "pageNum": 1,
            "pageSize": 10
          }
        }
      }
    },
    {
      "title": "获取角色详情",
      "method": "GET",
      "path": "/api/roles/{id}",
      "description": "根据角色ID获取角色详细信息",
      "requestParams": {
        "path": [
          {
            "name": "id",
            "type": "string",
            "required": true,
            "description": "角色ID"
          }
        ]
      },
      "responseExample": {
        "success": {
          "code": "0000",
          "message": "获取成功",
          "data": {
            "id": 1,
            "code": "ROLE0001",
            "name": "系统管理员",
            "status": 1,
            "permissions": [
              "PERM0001"
            ],
            "resources": [
              "RES0001"
            ]
          }
        },
        "failure": {
          "code": "4040",
          "message": "角色不存在",
          "data": null
        }
      }
    },
    {
      "title": "创建角色",
      "method": "POST",
      "path": "/api/roles",
      "description": "创建新的角色",
      "requestParams": {
        "body": {
          "name": "string｜必填，角色名称",
          "code": "string｜必填，角色编码，唯一",
          "status": "number｜可选，状态：1-启用，0-禁用"
        }
      },
      "responseExample": {
        "success": {
          "code": "0000",
          "message": "创建角色成功",
          "data": {
            "id": 1,
            "code": "ROLE0001",
            "name": "系统管理员",
            "status": 1,
            "permissions": [
              "PERM0001"
            ],
            "resources": [
              "RES0001"
            ]
          }
        },
        "failure": {
          "code": "4000",
          "message": "创建角色失败",
          "data": null
        }
      }
    },
    {
      "title": "更新角色",
      "method": "PUT",
      "path": "/api/roles/{id}",
      "description": "更新指定角色的信息",
      "requestParams": {
        "body": {
          "name": "string｜必填，角色名称",
          "code": "string｜必填，角色编码，唯一",
          "status": "number｜可选，状态：1-启用，0-禁用"
        },
        "path": [
          {
            "name": "id",
            "type": "string",
            "required": true,
            "description": "角色ID"
          }
        ]
      },
      "responseExample": {
        "success": {
          "code": "0000",
          "message": "更新角色成功",
          "data": {
            "id": 1,
            "code": "ROLE0001",
            "name": "系统管理员",
            "status": 1,
            "permissions": [
              "PERM0001"
            ],
            "resources": [
              "RES0001"
            ]
          }
        },
        "failure": {
          "code": "4000",
          "message": "更新角色失败",
          "data": null
        }
      }
    },
    {
      "title": "删除角色",
      "method": "DELETE",
      "path": "/api/roles/{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
        }
      }
    },
    {
      "title": "绑定角色权限",
      "method": "PUT",
      "path": "/api/roles/{id}/permissions",
      "description": "为指定角色绑定权限",
      "requestParams": {
        "body": {
          "name": "string｜必填，角色名称",
          "code": "string｜必填，角色编码，唯一",
          "status": "number｜可选，状态：1-启用，0-禁用"
        },
        "path": [
          {
            "name": "id",
            "type": "string",
            "required": true,
            "description": "角色ID"
          }
        ]
      },
      "responseExample": {
        "success": {
          "code": "0000",
          "message": "更新角色成功",
          "data": {
            "id": 1,
            "code": "ROLE0001",
            "name": "系统管理员",
            "status": 1,
            "permissions": [
              "PERM0001"
            ],
            "resources": [
              "RES0001"
            ]
          }
        },
        "failure": {
          "code": "4000",
          "message": "更新角色失败",
          "data": null
        }
      }
    },
    {
      "title": "绑定角色资源",
      "method": "PUT",
      "path": "/api/roles/{id}/resources",
      "description": "为指定角色绑定资源",
      "requestParams": {
        "body": {
          "name": "string｜必填，角色名称",
          "code": "string｜必填，角色编码，唯一",
          "status": "number｜可选，状态：1-启用，0-禁用"
        },
        "path": [
          {
            "name": "id",
            "type": "string",
            "required": true,
            "description": "角色ID"
          }
        ]
      },
      "responseExample": {
        "success": {
          "code": "0000",
          "message": "更新角色成功",
          "data": {
            "id": 1,
            "code": "ROLE0001",
            "name": "系统管理员",
            "status": 1,
            "permissions": [
              "PERM0001"
            ],
            "resources": [
              "RES0001"
            ]
          }
        },
        "failure": {
          "code": "4000",
          "message": "更新角色失败",
          "data": null
        }
      }
    }
  ]
}