diff --git a/docs/api/api_list.md b/docs/api/api_list.md index 8039580e..b9ae6fbd 100644 --- a/docs/api/api_list.md +++ b/docs/api/api_list.md @@ -19,18 +19,18 @@ 加密采用AES/CBC/ZeroPadding加密方式，密钥长度为16位。，IV长度为16位（每次请求时随机生成）。 -# 登录模块API接口 +# 1、登录模块API接口 ## API接口一览表 | 接口分类 | 接口描述 | API接口 | 权限 | |:-----:| :------- |:--------------------------|-----------------| -| 获取验证码 | 获取验证码 | /api/auth/captchaImage | | -| 系统登录 | 系统登录 | /api/auth/login | /XXXX/XXX/XXX/X | -| 系统登录 | 退出登录 | /api/auth/logout | | -| 系统登录 | 修改密码 | /api/auth/password/change | | +| 获取验证码 | 1.1、获取验证码 | /api/auth/captchaImage | | +| 系统登录 | 1.2、系统登录 | /api/auth/login | | +| 系统登录 | 1.3、退出登录 | /api/auth/logout | | +| 系统登录 | 1.4、修改密码 | /api/auth/password/change | | -## 验证码获取 +## 1.1、验证码获取 > /api/auth/captchaImage @@ -56,7 +56,7 @@ | img | String | No | 图片base64编码 | | key | String | No | 验证码唯一标志 | -## 系统登录 +## 1.2、系统登录 使用用户名和密码，验证码和验证码的唯一标识登录系统，POST请求 @@ -100,7 +100,7 @@ | -------------------- |--------| -------- | -------------------------- | | token | String | No | 令牌(未加密) | -## 退出登录 +## 1.3、退出登录 注销令牌退出登录，POST请求 @@ -118,7 +118,7 @@ } ``` -## 修改密码 +## 1.4、修改密码 修改登录密码，POST请求 @@ -152,6 +152,204 @@ } ``` +# 2、菜单管理 + +## API接口一览表 + +| 接口分类 | 接口描述 | API接口 | 权限 | +| :------: | :------------ | :---------------- | ---- | +| 菜单管理 | 2.1、新增菜单 | /api/menus | | +| 菜单管理 | 2.2、查询菜单 | /api/menus/query | | +| 菜单管理 | 2.3、更新菜单 | /api/menus/update | | +| 菜单管理 | 2.4、删除菜单 | /api/menus/delete | | + +## 2.1、新增菜单 + +```java +@PostMapping("/api/menus") +public ResponseEntity createMenu(@RequestBody MenuDto menuDto) { + // 处理菜单的创建逻辑 + // ... +} +``` + +入参定义 + +```java +import lombok.Data; +import java.io.Serializable; + +@Data +public class MenuDto implements Serializable { + /** 菜单ID */ + private Long id ; + /** 菜单名称 */ + private String menuName ; + /** 菜单排列顺序 */ + private Integer menuOrder ; + /** 菜单图标名称 */ + private String menuIcon ; + /** 菜单操作类型 */ + private Integer funType ; + /** 菜单操作参数 */ + private String funParam ; + /** 权限ID */ + private Long authorityId ; + /** 上级菜单ID */ + private Long parentMenuId ; + /** 乐观锁 */ + private Integer revision ; + /** 创建人 */ + private String createdBy ; + /** 创建时间 */ + private Date createdTime ; + /** 更新人 */ + private String updatedBy ; + /** 更新时间 */ + private Date updatedTime ; +} +``` + +调用成功返回示例 + +```json +{ + "code": 200, + "msg": "操作成功", + "data": { + "id": "123", + "menuName": "菜单1", + "menuOrder": 1, + "menuIcon": "icon1", + "funType": 1, + "funParam": "param", + "authorityId": "123", + "parentMenuId": "0", + "revision": 1, + "createdBy": "aaa", + "createdTime": 123456, + "updatedBy": "aaa", + "updatedTime": 12345 + } +} +``` + +## 2.2、查询菜单 + +```java +@PostMapping("/api/menus/query") +public ResponseEntity queryMenus(@RequestBody MenuQueryDto menuQueryDto) { + // 处理查询逻辑并返回菜单列表 + // ... + return ResponseEntity.ok(menus); // 假设menus是查询结果列表 +} +``` + +入参定义 + +```java +import lombok.Data; +import java.io.Serializable; + +@Data +public class MenuQueryDto implements Serializable { + /** 菜单ID */ + private Long id ; + /** 上级菜单ID */ + private Long parentMenuId ; +} +``` + +调用成功返回示例 + +```json +{ + "code": 200, + "msg": "操作成功", + "data": [ + { + "id": "123", + "menuName": "菜单1", + "menuOrder": 1, + "menuIcon": "icon1", + "funType": 1, + "funParam": "param", + "authorityId": "123", + "parentMenuId": "0", + "revision": 1, + "createdBy": "aaa", + "createdTime": 123456, + "updatedBy": "aaa", + "updatedTime": 12345 + } + ] +} +``` + +## 2.3、更新菜单 + +```java +@PostMapping("/api/menus/update") +public ResponseEntity updateMenu(@RequestBody MenuUpdateDto menuUpdateDto) { + // 验证ID并处理菜单的更新逻辑 + // ... + return ResponseEntity.ok().build(); +} + +// MenuUpdateDto 示例 +public class MenuUpdateDto { + /** 菜单ID */ + private Long id ; + /** 菜单名称 */ + private String menuName ; + /** 菜单排列顺序 */ + private Integer menuOrder ; + /** 菜单图标名称 */ + private String menuIcon ; + /** 菜单操作类型 */ + private Integer funType ; + /** 菜单操作参数 */ + private String funParam ; + /** 权限ID */ + private Long authorityId ; + /** 上级菜单ID */ + private Long parentMenuId ; + /** 乐观锁 */ + private Integer revision ; + /** 创建人 */ + private String createdBy ; + /** 创建时间 */ + private Date createdTime ; + /** 更新人 */ + private String updatedBy ; + /** 更新时间 */ + private Date updatedTime ; +} +``` + + + +## 2.4、删除菜单 + +```java +@PostMapping("/api/menus/delete") +public ResponseEntity deleteMenu(@RequestBody MenuDeleteDto menuDeleteDto) { + // 验证ID并处理菜单的删除逻辑 + // ... + return ResponseEntity.noContent().build(); +} + +// MenuDeleteDto 示例 +public class MenuDeleteDto { + /** 菜单ID */ + private Long id; +} +``` + + + + + !> 下面的文档有待确认 # 公司机构模块API接口 @@ -1344,10 +1542,6 @@ | 系统角色操作 | 系统角色新增 | /api/user/addSysRole | | | 系统角色操作 | 角色权限查询 | /api/user/getAuthorityById | | | 系统角色操作 | 角色权限编辑 | /api/user/updateAuthorityById | | -| 菜单管理操作 | 系统菜单查询 | /api/user/getSysMenuList | | -| 菜单管理操作 | 系统菜单删除 | /api/user/addSysMenu | | -| 菜单管理操作 | 系统菜单新增 | /api/user/deleteSysMenu | | -| 菜单管理操作 | 系统菜单编辑 | /api/user/updateSysMenu | | ## 系统权限管理 @@ -1741,196 +1935,6 @@ api/user/addSysRole } ``` -## 菜单管理 - -### 系统菜单查询 - -提供获取所有系统菜单的功能，POST方式 - -/api/user/getSysMenuList - -入参示例 - -``` -{ -"menuName":"xxx", -"parentMenuId":"xxx", -"token":"xxx" -} -``` - -入参描述 - -| 参数名 | 参数类型 | 可选 | 描述 | -| :----------- | :------: | :---: | :--------------------------------- | -| menuName | String | yes | 系统菜单名称为空时查询所有系统角色 | -| parentMenuId | BIGINT | yes | 上级菜单ID | -| token | String | NO | token | - -调用成功返回示例 - -```json -{ - "code":"200", - "msg":"调用成功", - "data":[ - { - "id": "xxxx", - "menuName": "xxx", - "menuOrder":"XX", - "menuIcon":"XX", - "funType": "xxx", - "funParam": "xxxx", - "authorityId": "xxx", - "parentMenuId": "xxxx" - }, - { - ... - } - ] -} -``` - -| 变量名 | 变量类型 | 可为NULL | 描述 | -| ------------ | -------- | -------- | ------------ | -| id | BIGINT | No | 菜单ID | -| menuName | string | No | 菜单名称 | -| menuOrder | INT | No | 菜单排列顺序 | -| menuIcon | string | No | 菜单图标名称 | -| funType | INT | No | 菜单操作类型 | -| funParam | string | No | 菜单操作参数 | -| authorityId | BIGINT | No | 权限ID | -| parentMenuId | BIGINT | No | 上级菜单ID | - -### 系统菜单新增 - -根据添加的信息创建系统菜单，POST方式 - -/api/user/addSysMenu - -入参示例 - -``` -{ - "menuName": "xxx", - "menuOrder":"XX", - "menuIcon":"XX", - "funType": "xxx", - "funParam": "xxxx", - "authorityId": "xxx", - "parentMenuId": "xxxx" - "menuName":"xxx", - "parentMenuId":"xxx" - "authorityList":["12","12"], - "token":"xxx" -} -``` - -入参描述 - -| 变量名 | 变量类型 | 可为NULL | 描述 | -| ------------ | -------- | -------- | ------------ | -| menuName | string | No | 菜单名称 | -| menuOrder | INT | No | 菜单排列顺序 | -| menuIcon | string | No | 菜单图标名称 | -| funType | INT | No | 菜单操作类型 | -| funParam | string | No | 菜单操作参数 | -| authorityId | BIGINT | No | 权限ID | -| parentMenuId | BIGINT | No | 上级菜单ID | -| token | String | NO | token | - -调用成功返回示例 - -```json -{ -"code":"200", -"msg":"新增成功", -"data":"null" -} -``` - -### 系统菜单删除 - -根据提供的ID,删除系统菜单，POST方式 - -/api/user/deleteSysMenu - -入参示例 - -``` -{ - "id":"xx", - "token":"xxx" -} -``` - -入参描述 - -| 参数名 | 参数类型 | 可选 | 描述 | -| :----- | :------: | :---: | :----- | -| id | String | no | 菜单id | -| token | String | NO | token | - -调用成功返回示例 - -```json -{ -"code":"200", -"msg":"删除成功", -"data":"null" -} -``` - -### 系统菜单编辑 - -根据提供的ID,修改系统菜单，POST方式 - -/api/user/updateSysMenu - -入参示例 - -``` -{ -"id":"xxx", - "menuName": "xxx", - "menuOrder":"XX", - "menuIcon":"XX", - "funType": "xxx", - "funParam": "xxxx", - "authorityId": "xxx", - "parentMenuId": "xxxx" - "menuName":"xxx", - "parentMenuId":"xxx" - "authorityList":["12","12"], - "token":"xxx" -} -``` - -入参描述 - -| 变量名 | 变量类型 | 可为NULL | 描述 | -| ------------- | ------------ | -------- | ------------ | -| id | string | No | 菜单id | -| menuName | string | No | 菜单名称 | -| menuOrder | string | No | 菜单排列顺序 | -| menuIcon | string | No | 菜单图标名称 | -| funType | string | No | 菜单操作类型 | -| funParam | string | No | 菜单操作参数 | -| authorityId | string | No | 权限ID | -| parentMenuId | string | No | 上级菜单ID | -| authorityList | List | yes | 角色的权限id | -| token | String | NO | token | - -调用成功返回示例 - -```json -{ -"code":"200", -"msg":"编辑成功", -"data":"null" -} -``` - # 链路模块API接口 ## API接口一览表