{
  "openapi": "3.0.3",
  "info": {
    "title": "角色管理",
    "version": "1.0.0",
    "description": "角色管理相关接口文档"
  },
  "paths": {
    "/api/roles": {
      "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": "name",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "description": "角色名称关键词"
          },
          {
            "name": "code",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "description": "角色编码"
          }
        ],
        "responses": {
          "200": {
            "description": "成功响应",
            "content": {
              "application/json": {
                "example": {
                  "success": {
                    "code": "0000",
                    "message": "获取成功",
                    "data": {
                      "list": [
                        {
                          "id": 1,
                          "code": "ROLE0001",
                          "name": "系统管理员",
                          "status": 1,
                          "permissions": [
                            "PERM0001"
                          ],
                          "resources": [
                            "RES0001"
                          ]
                        }
                      ],
                      "total": 100,
                      "pageNum": 1,
                      "pageSize": 10
                    }
                  }
                }
              }
            }
          }
        }
      },
      "post": {
        "summary": "创建角色",
        "description": "创建新的角色",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string",
                    "description": "string｜必填，角色名称"
                  },
                  "code": {
                    "type": "string",
                    "description": "string｜必填，角色编码，唯一"
                  },
                  "status": {
                    "type": "number",
                    "description": "number｜可选，状态：1-启用，0-禁用"
                  }
                },
                "required": [
                  "name",
                  "code"
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "成功响应",
            "content": {
              "application/json": {
                "example": {
                  "success": {
                    "code": "0000",
                    "message": "创建角色成功",
                    "data": {
                      "id": 1,
                      "code": "ROLE0001",
                      "name": "系统管理员",
                      "status": 1,
                      "permissions": [
                        "PERM0001"
                      ],
                      "resources": [
                        "RES0001"
                      ]
                    }
                  },
                  "failure": {
                    "code": "4000",
                    "message": "创建角色失败",
                    "data": null
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/roles/{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,
                      "code": "ROLE0001",
                      "name": "系统管理员",
                      "status": 1,
                      "permissions": [
                        "PERM0001"
                      ],
                      "resources": [
                        "RES0001"
                      ]
                    }
                  },
                  "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": {
                  "name": {
                    "type": "string",
                    "description": "string｜必填，角色名称"
                  },
                  "code": {
                    "type": "string",
                    "description": "string｜必填，角色编码，唯一"
                  },
                  "status": {
                    "type": "number",
                    "description": "number｜可选，状态：1-启用，0-禁用"
                  }
                },
                "required": [
                  "name",
                  "code"
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "成功响应",
            "content": {
              "application/json": {
                "example": {
                  "success": {
                    "code": "0000",
                    "message": "更新角色成功",
                    "data": {
                      "id": 1,
                      "code": "ROLE0001",
                      "name": "系统管理员",
                      "status": 1,
                      "permissions": [
                        "PERM0001"
                      ],
                      "resources": [
                        "RES0001"
                      ]
                    }
                  },
                  "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
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/roles/{id}/permissions": {
      "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": {
                  "name": {
                    "type": "string",
                    "description": "string｜必填，角色名称"
                  },
                  "code": {
                    "type": "string",
                    "description": "string｜必填，角色编码，唯一"
                  },
                  "status": {
                    "type": "number",
                    "description": "number｜可选，状态：1-启用，0-禁用"
                  }
                },
                "required": [
                  "name",
                  "code"
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "成功响应",
            "content": {
              "application/json": {
                "example": {
                  "success": {
                    "code": "0000",
                    "message": "更新角色成功",
                    "data": {
                      "id": 1,
                      "code": "ROLE0001",
                      "name": "系统管理员",
                      "status": 1,
                      "permissions": [
                        "PERM0001"
                      ],
                      "resources": [
                        "RES0001"
                      ]
                    }
                  },
                  "failure": {
                    "code": "4000",
                    "message": "更新角色失败",
                    "data": null
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/roles/{id}/resources": {
      "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": {
                  "name": {
                    "type": "string",
                    "description": "string｜必填，角色名称"
                  },
                  "code": {
                    "type": "string",
                    "description": "string｜必填，角色编码，唯一"
                  },
                  "status": {
                    "type": "number",
                    "description": "number｜可选，状态：1-启用，0-禁用"
                  }
                },
                "required": [
                  "name",
                  "code"
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "成功响应",
            "content": {
              "application/json": {
                "example": {
                  "success": {
                    "code": "0000",
                    "message": "更新角色成功",
                    "data": {
                      "id": 1,
                      "code": "ROLE0001",
                      "name": "系统管理员",
                      "status": 1,
                      "permissions": [
                        "PERM0001"
                      ],
                      "resources": [
                        "RES0001"
                      ]
                    }
                  },
                  "failure": {
                    "code": "4000",
                    "message": "更新角色失败",
                    "data": null
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}