Skip to content

角色管理相关接口

获取个人角色信息

请求URL

  • /api/v1/role/getRoleInfo

请求方式

  • GET

请求头

  • Authorization': token

返回示例

json
{
  "code": 200,
  "data": {
    "role": {
      "id": 2,
      "name": "",
      "code": "",
      "desc": "",
      "homePage": "",
      "createdAt": "2021-07-16T08:49:54Z",
    },
  },
  "msg": "ok"
}

返回参数说明

参数名类型说明
idint角色ID
namestring角色名
codestring角色代码
descstring简介
homePagestring角色首页
createdAtstring创建时间

备注

获取角色列表

请求URL

  • /api/v1/role/getRoleList

请求方式

  • POST

请求头

  • Authorization': token
  • "content-type": "application/json"

请求参数

参数名必选类型说明
pageint页码
pageSizeint页面数量,最大100

返回示例

json
{
  "code": 200,
  "data": {
    "total": 1,
    "list": [
      {
        "id": 2,
        "name": "",
        "code": "",
        "desc": "",
        "homePage": "",
        "createdAt": "2021-07-16T08:49:54Z",
      },
    ]
  },
  "msg": "ok"
}

返回参数说明

参数名类型说明
totalint数量
listobject角色信息数组
角色信息
参数名类型说明
idint角色ID
namestring角色名
codestring角色代码
descstring简介
homePagestring角色首页
createdAtstring创建时间

备注

获取全部角色列表

请求URL

  • /api/v1/role/getAllRoleList

请求方式

  • GET

请求头

  • Authorization': token

返回示例

json
{
  "code": 200,
  "data": {
    "roles": [
      {
        "name": "",
        "code": "",
      },
    ]
  },
  "msg": "ok"
}

返回参数说明

参数名类型说明
namestring角色名
codestring角色代码

备注

新增角色

请求URL

  • /api/v1/role/addRole

请求方式

  • POST

请求头

  • Authorization': token
  • "content-type": "application/json"

参数

参数名必选类型说明
namestring角色名
codestring角色代码
descstring简介

返回示例

json
{
  "code": 200,
  "data": null,
  "msg":"ok"
}

备注

编辑角色

请求URL

  • /api/v1/role/editRole

请求方式

  • PUT

请求头

  • Authorization': token
  • "content-type": "application/json",

参数

参数名必选类型说明
idint角色ID
namestring角色名
descstring简介

返回示例

json
{
  "code": 200,
  "data": null,
  "msg":"ok"
}

备注

删除角色

请求URL

  • /api/v1/role/deleteRole/角色ID

请求方式

  • DELETE

请求头

  • Authorization': token

返回示例

json
{
  "code": 200,
  "data": null,
  "msg": "ok"
}

备注

编辑角色首页

请求URL

  • /api/v1/role/editRoleHome

请求方式

  • PUT

请求头

  • Authorization': token
  • "content-type": "application/json",

参数

参数名必选类型说明
idint角色ID
homestring角色首页

返回示例

json
{
  "code": 200,
  "data": null,
  "msg":"ok"
}

备注

根据 MIT 许可证发布