sx/map
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

das接口文档修改

Browse Source
This commit is contained in:
chenhaojie 2024-06-25 18:16:08 +08:00
parent 205c25e5f9
commit 5a2eb8e6ad
1 changed files with 53 additions and 90 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

143
docs/api/api_list.md
View File

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