das接口文档修改

This commit is contained in:
chenhaojie 2024-06-25 21:01:50 +08:00
parent c14bcfce08
commit 2003dad98a

View File

@ -332,7 +332,113 @@
}
```
## 2.5、获取所有菜单
```java
请求接口 /api/menus/list
```
入参定义
```json
{
"parentMenuId": 0,
"recursive": true
}
```
调用成功返回示例
```json
{
"code": 200,
"msg": "操作成功",
"success": true,
"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.6、获取绑定菜单
```java
请求接口 /api/menus/tree
```
入参定义
```json
```
调用成功返回示例
```json
{
"code": 200,
"success": true,
"data": {
"id": 73216735447089152,
"menuName": "测试1",
"menuOrder": 0,
"menuIcon": "",
"funType": 0,
"funParam": "",
"authorityId": 101,
"parentMenuId": 0,
"revision": 2,
"createdTime": "2024-06-25 07:14:40",
"updatedTime": "2024-06-25 07:14:40",
"children": [
{
"id": 73216795998158848,
"menuName": "测试2",
"menuOrder": 0,
"menuIcon": "",
"funType": 1,
"funParam": "2",
"authorityId": 101,
"parentMenuId": 73216735447089152,
"revision": 1,
"createdTime": "2024-06-25 07:18:31",
"updatedTime": "2024-06-25 07:18:31",
"children": [
{
"id": 73216799741313024,
"menuName": "测试3",
"menuOrder": 0,
"menuIcon": "",
"funType": 1,
"funParam": "333",
"authorityId": 101,
"parentMenuId": 73216795998158848,
"revision": 1,
"createdTime": "2024-06-25 07:18:45",
"updatedTime": "2024-06-25 07:18:45",
"children": []
}
]
}
]
},
"msg": "操作成功"
}
```
!> 下面的文档有待确认
@ -580,7 +686,52 @@
}
```
## 获取机构列表
根据获取机构列表POST方式
>/api/org/list
入参示例
```json
{
"parentOrgId":111,
"recursive": true
}
```
入参描述
| 参数名 | 参数类型 | 可选 | 描述 |
| ------ |---------| ---- |--------|
| parentOrgId | Long | No | 机构id |
| recursive | boolean | No | 是否是根节点 |
调用成功返回示例
```json
{
"code": 200,
"success": true,
"data": [
{
"id": "2",
"name": "测试子公司",
"mrid": "456",
"province": "江苏",
"city": "南京",
"county": "玄武",
"address": "测试地址1",
"contactPhone": "555889",
"remarks": "测试",
"parentOrgId": 1,
"revision": 1
}
],
"msg": "操作成功"
}
```
# 4、职员模块API接口