diff --git a/docs/api/api_list.md b/docs/api/api_list.md index 02c0e1ce..eb475f95 100644 --- a/docs/api/api_list.md +++ b/docs/api/api_list.md @@ -841,14 +841,13 @@ 提供获取所有系统角色的功能,POST方式 -/api/user/getSysRole +/api/role/query 入参示例 -``` +```json { - "roleName":"xxx",, - "token":"xxx" + "roleName":"xxx" } ``` @@ -857,25 +856,24 @@ | 参数名 | 参数类型 | 可选 | 描述 | | :------- | :------: | :--: | :----------------------------- | | roleName | String | YES | 系统角色为空时查询所有系统角色 | -| token | String | NO | token | 调用成功返回示例 ```json { - "code":"200", - "msg":"调用成功", - "data":[ + "total": 1, + "rows": [ { - "id": "xxxx", - "roleCode": "xxx", - "roleName": "xxx", - - }, - { - ... + "createdTime": "2024-06-25 11:15:48", + "updatedTime": "2024-06-25 11:15:48", + "id": "73212978522226688", + "roleCode": "001", + "roleName": "测试角色", + "revision": 1 } - ] + ], + "code": 200, + "msg": "查询成功" } ``` @@ -889,15 +887,13 @@ 根据提供的ID,删除系统角色,POST方式 -/api/user/deleteSysRole +/api/role/delete 入参示例 -``` +```json { - "id":"xxx",, - "token":"xxx" -} + "id":"xxx" ``` 入参描述 @@ -905,15 +901,14 @@ | 参数名 | 参数类型 | 可选 | 描述 | | :----- | :------: | :--: | :--------- | | id | BIGINT | NO | 系统角色id | -| token | String | NO | token | 调用成功返回示例 ```json { -"code":"200", -"msg":"删除成功", -"data":"null" + "code": 200, + "success": true, + "msg": "操作成功" } ``` @@ -921,37 +916,42 @@ 根据添加的信息创建系统角色,POST方式 -/api/user/addSysRole +/api/role/add 入参示例 -``` +```json { -"id":"xxx", -"roleCode":"XX", -"roleName":"XX", -"authorityList":["12","12"], -"token":"xxx" + "roleName":"测试角色", + "roleCode":"001", + "authList":[101,102,103] } ``` 入参描述 -| 参数名 | 参数类型 | 可选 | 描述 | -| :------------ | :----------: | :--: | :----------- | -| id | BIGINT | no | 系统角色id | -| roleCode | String | no | 角色编码 | -| roleName | String | no | 角色名称 | -| authorityList | List | yes | 角色的权限id | -| token | String | NO | token | +| 参数名 | 参数类型 | 可选 | 描述 | +| :------------ |:----------:| :--: | :----------- | +| roleCode | String | no | 角色编码 | +| roleName | String | no | 角色名称 | +| authList | List | yes | 角色的权限id | 调用成功返回示例 ```json { -"code":"200", -"msg":"新增成功", -"data":"null" + "code": 200, + "success": true, + "data": { + "roleName": "测试角色", + "roleCode": "001", + "authList": [ + 101, + 102, + 103 + ] + }, + "msg": "操作成功" } ``` @@ -959,14 +959,13 @@ 提供获取所有角色权限的功能,POST方式 -/api/user/getAuthorityById +/api/role/queryAuthorityById 入参示例 -``` +```json { - "id":"xxx", - "token":"xxx" + "id":"xxx" } ``` @@ -975,7 +974,6 @@ | 参数名 | 参数类型 | 可选 | 描述 | | :----- | :------: | :--: | :--------- | | id | BIGINT | NO | 系统角色id | -| token | String | NO | token | 调用成功返回示例 @@ -1001,65 +999,30 @@ | authorityCode | string | No | 权限编码 | | authorityName | string | No | 权限名称 | -api/user/addSysRole - -入参示例 - -``` -{ -"id":"xxx", -"roleCode":"XX", -"roleName":"XX", -"authorityList":["12","12"], -"token":"xxx" -} -``` - -入参描述 - -| 参数名 | 参数类型 | 可选 | 描述 | -| :------------ | :----------: | :--: | :----------- | -| id | BIGINT | no | 系统角色id | -| roleCode | String | no | 角色编码 | -| roleName | String | no | 角色名称 | -| authorityList | List | yes | 角色的权限id | -| token | String | NO | token | - -调用成功返回示例 - -```json -{ -"code":"200", -"msg":"新增成功", -"data":"null" -} -``` ### 角色权限编辑 根据提供的ID,修改角色权限,POST方式 -/api/user/updateAuthorityById +/api/role/update 入参示例 -``` +```json { "id":"xxx", "roleName":"XX", -"authorityList":["12","12"], -"token":"xxx" +"authList":[12,13] } ``` 入参描述 -| 参数名 | 参数类型 | 可选 | 描述 | -| :------------ | :----------: | :--: | :----------- | -| id | BIGINT | no | 系统角色id | -| roleName | String | no | 角色名称 | -| authorityList | List | yes | 角色的权限id | -| token | String | NO | token | +| 参数名 | 参数类型 | 可选 | 描述 | +| :------------ |:----------:| :--: | :----------- | +| id | BIGINT | no | 系统角色id | +| roleName | String | no | 角色名称 | +| authList | List | yes | 角色的权限id | 调用成功返回示例