菜单管理

获取左侧菜单

简要描述

前端项目在用户登录成功之后会获取用户的菜单树

请求 URL

http://x.x.x.x:8080/menu/tree

请求方式

请求示例

无

请求参数

无

返回示例

{
  "code": 200,
  "msg": "成功",
  "data": [
    {
      "id": "1",
      "pid": "0",
      "sort": 0,
      "skip": true,
      "name": "主页",
      "icon": "home",
      "path": "/space/home",
      "level": 1,
      "type": 1,
      "options": 1,
      "description": null,
      "createUser": "1",
      "updateTime": "2023-10-15 15:13:34"
    },
    {
      "id": "2",
      "pid": "0",
      "sort": 1,
      "skip": false,
      "children": [
        {
          "id": "192",
          "pid": "2",
          "sort": null,
          "skip": false,
          "name": null,
          "icon": null,
          "path": "/idea/192",
          "level": 2,
          "type": 0,
          "options": 0,
          "description": null,
          "createUser": "2",
          "updateTime": "2024-04-16 20:38:00"
        }
      ],
      "name": "我的空间",
      "icon": "personal",
      "path": "/space/personal",
      "level": 1,
      "type": 1,
      "options": 0,
      "description": null,
      "createUser": "1",
      "updateTime": "2023-10-15 15:13:34"
    },
    {
      "id": "3",
      "pid": "0",
      "sort": 2,
      "skip": false,
      "name": "团队空间",
      "icon": "team",
      "path": "/space/team",
      "level": 1,
      "type": 1,
      "options": 0,
      "description": null,
      "createUser": "1",
      "updateTime": "2023-10-15 15:13:34"
    }
  ],
  "success": true
}

返回参数

| 参数名 | 类型 | 说明 | | :---------- | :------ | ------------------ | --- | | code | int | 200成功，非200失败 | | msg | string | 错误信息 | | id | string | 唯一标识 | | pid | string | 父 id，唯一标识 | | sort | string | 排序 | | skip | string | 内部字段 | | name | string | 菜单名称 | | icon | string | 菜单 icon | | path | string | 菜单路径 | | level | string | 菜单层级 | | type | string | 菜单类型 | | options | string | 菜单是否可操作 | | description | string | 菜单描述 | | createUser | string | 创建人 | | updateTime | string | 更新时间 | | success | boolean | 是否成功 | 树 |

分页获取菜单列表

简要描述

分页获取菜单列表

请求 URL

http://x.x.x.x:8080/menu/page

请求方式

请求示例

{
  "current": 1,
  "pageSize": 10,
  "menuId": 2
}

请求参数

参数名	类型	必选	说明
current	number	是	当前页
pageSize	number	是	每页条数
menuId	number	是	菜单 id

返回示例

{
  "code": 200,
  "msg": "成功",
  "data": {
    "records": [
      {
        "id": "192",
        "pid": "2",
        "name": null,
        "icon": null,
        "path": "/idea/192",
        "level": 2,
        "sort": null,
        "type": 0,
        "options": 0,
        "description": null,
        "createUser": "2",
        "updateTime": "2024-04-16 20:38:00",
        "deleted": 0
      },
      {
        "id": "191",
        "pid": "2",
        "name": null,
        "icon": null,
        "path": "/idea/191",
        "level": 2,
        "sort": null,
        "type": 0,
        "options": 0,
        "description": null,
        "createUser": "2",
        "updateTime": "2024-04-16 20:37:33",
        "deleted": 0
      },
      {
        "id": "189",
        "pid": "2",
        "name": null,
        "icon": null,
        "path": "/idea/189",
        "level": 2,
        "sort": null,
        "type": 0,
        "options": 0,
        "description": null,
        "createUser": "2",
        "updateTime": "2024-04-16 20:36:29",
        "deleted": 0
      }
    ],
    "total": "3",
    "current": "1",
    "pages": "1",
    "hasPrevious": false,
    "hasNext": false
  },
  "success": true
}

返回参数

参数名	类型	说明
code	int	200成功，非200失败
msg	string	错误信息
total	number	总条数
current	number	当前页
pages	number	总页数
hasPrevious	boolean	是否有上一页
hasNext	boolean	是否有下一页
id	string	唯一标识
pid	string	父 id，唯一标识
sort	string	排序
skip	string	内部字段
name	string	菜单名称
icon	string	菜单 icon
path	string	菜单路径
level	string	菜单层级
type	string	菜单类型
options	string	菜单是否可操作
description	string	菜单描述
createUser	string	创建人
updateTime	string	更新时间
success	boolean	是否成功

创建文件夹

简要描述

创建文件夹

请求 URL

http://x.x.x.x:8080/menu/save

请求方式

POST

请求示例

{
  "pid": 1,
  "name": "Open-Idea",
  "type": 1,
  "description": "随时随地记录想法"
}

请求参数

参数名	类型	必选	说明
pid	number	是	父级id
name	string	是	文件夹/文件名称
type	number	是	文件夹
description	number	是	描述

返回示例

{
  "code": 200,
  "msg": "成功",
  "data": null,
  "success": true
}

返回参数

参数名	类型	说明
code	int	200成功，非200失败
msg	string	错误信息
success	boolean	是否成功

修改菜单名称

简要描述

修改菜单名称

请求 URL

http://x.x.x.x:8080/menu/update

请求方式

请求示例

{
  "id": 1,
  "name": "Open-Idea",
  "description": "随时随地记录想法"
}

请求参数

参数名	类型	必选	说明
id	number	是	父级id
name	string	是	文件夹/文件名称
description	number	是	描述

返回示例

{
  "code": 200,
  "msg": "成功",
  "data": null,
  "success": true
}

返回参数

参数名	类型	说明
code	int	200成功，非200失败
msg	string	错误信息
success	boolean	是否成功

PreviousAPI 文档 Next文档管理