前端 API 请求函数文档

一、首页相关 API

1. 获取访问排行列表

函数：getVisitTopList()
功能：获取按访问量和更新时间降序排列的前 6 条新闻列表
参数：无
请求方式：GET
请求地址：/newsList?_sort=visitNum,updateTime&_order=desc,desc&_limit=6

2. 获取点赞排行列表

函数：getLikeTopList()
功能：获取按点赞数和更新时间降序排列的前 6 条新闻列表
参数：无
请求方式：GET
请求地址：/newsList?_sort=likeNum,updateTime&_order=desc,desc&_limit=6

二、菜单相关 API

1. （超级）管理员获取菜单

函数：getMenu()
功能：获取带有子菜单且权限为 1 的菜单列表
参数：无
请求方式：GET
请求地址：/menu?_embed=children&permission=1

2. 普通用户获取菜单

函数：getMenuForUser()
功能：获取 id 为 1 和 4 且带有子菜单且权限为 1 的菜单列表
参数：无
请求方式：GET
请求地址：/menu?id=1&id=4&_embed=children&permission=1

三、登录相关 API

1. 登录

函数：login(userName='',password='')
功能：根据用户名和密码进行登录验证
参数：
- userName：用户名，字符串类型，默认值为空
- password：密码，字符串类型，默认值为空
请求方式：GET
请求地址：/usersList?userName=${userName}&password=${password}

四、权限管理相关 API

1. 获取权限列表

函数：getCompetenceList()
功能：获取带有子菜单的权限列表
参数：无
请求方式：GET
请求地址：/menu?_embed=children

2. 权限列表父级菜单配置开关

函数：patchPermissionTrigger(id,permission)
功能：修改父级菜单的权限状态
参数：
- id：父级菜单唯一标识
- permission：权限标识，1 表示打开，0 表示关闭
请求方式：PATCH
请求地址：/menu/${id},{permission}

3. 权限列表子级菜单配置开关

函数：patchChildPermissionTrigger(id,permission)
功能：修改子级菜单的权限状态
参数：
- id：子级菜单唯一标识
- permission：权限标识，1 表示打开，0 表示关闭
请求方式：PATCH
请求地址：/children/${id},{permission}