mrzcc
2020-01-19 495192538c70749522b9a9d467d3aa32eae6fd4f
新增菜单权限组增删改查询接口文档
2个文件已添加
138 ■■■■■ 已修改文件
docs/document/api/menu/deleteMenuGroup.md 67 ●●●●● 补丁 | 查看 | 原始文档 | blame | 历史
docs/document/api/menu/updateMenuGroup.md 71 ●●●●● 补丁 | 查看 | 原始文档 | blame | 历史
docs/document/api/menu/deleteMenuGroup.md
New file
@@ -0,0 +1,67 @@
**1\. 删除权限组**
###### 接口功能
> 删除权限组接口
###### URL
> [http://api.java110.com:8008/api/menuGroup.deleteMenuGroup](http://api.java110.com:8008/api/menuGroup.deleteMenuGroup)
###### 支持格式
> JSON
###### HTTP请求方式
> POST
###### 请求参数(header部分)
|参数名称|约束|类型|长度|描述|取值说明|
| :-: | :-: | :-: | :-: | :-: | :-:|
|app_id|1|String|30|应用ID|Api服务分配|
|transaction_id|1|String|30|请求流水号|不能重复 1000000000+YYYYMMDDhhmmss+6位序列 |
|sign|1|String|-|签名|请参考签名说明|
|req_time|1|String|-|请求时间|YYYYMMDDhhmmss|
###### 请求参数(body部分)
|参数名称|约束|类型|长度|描述|取值说明|
| :-: | :-: | :-: | :-: | :-: | :-: |
|pid|1|String|30|权限ID|-|
###### 返回协议
当http返回状态不为200 时请求处理失败 body内容为失败的原因
当http返回状态为200时请求处理成功,body内容为返回内容,
###### 举例
> 地址:[http://api.java110.com:8008/api/menuGroup.deleteMenuGroup](http://api.java110.com:8008/api/menuGroup.deleteMenuGroup)
``` javascript
请求头信息:
Content-Type:application/json
USER_ID:1234
APP_ID:8000418002
TRANSACTION_ID:10029082726
REQ_TIME:20181113225612
SIGN:aabdncdhdbd878sbdudn898
请求报文:
{
    description: "测试组1"
    gId: "1234444"
    icon: "fa fa-globe"
    label: "TOP"
    name: "测试组1"
    seq: "16"
    communityId: "7020181217000001"
}
返回报文:
成功
```
docs/document/api/menu/updateMenuGroup.md
New file
@@ -0,0 +1,71 @@
**1\. 编辑菜单组**
###### 接口功能
> 编辑菜单组接口
###### URL
> [http://api.java110.com:8008/api/menuGroup.updateMenuGroup](http://api.java110.com:8008/api/menuGroup.updateMenuGroup)
###### 支持格式
> JSON
###### HTTP请求方式
> POST
###### 请求参数(header部分)
|参数名称|约束|类型|长度|描述|取值说明|
| :-: | :-: | :-: | :-: | :-: | :-:|
|app_id|1|String|30|应用ID|Api服务分配|
|transaction_id|1|String|30|请求流水号|不能重复 1000000000+YYYYMMDDhhmmss+6位序列 |
|sign|1|String|-|签名|请参考签名说明|
|req_time|1|String|-|请求时间|YYYYMMDDhhmmss|
###### 请求参数(body部分)
|参数名称|约束|类型|长度|描述|取值说明|
| :-: | :-: | :-: | :-: | :-: | :-: |
|name|1|String|10|组名称|-|
|icon|1|String|20|菜单图片|-|
|label|1|String|20|标签|-|
|seq|1|int|11|序列|-|
|gId|1|String|30|ID|-|
###### 返回协议
当http返回状态不为200 时请求处理失败 body内容为失败的原因
当http返回状态为200时请求处理成功,body内容为返回内容,
###### 举例
> 地址:[http://api.java110.com:8008/api/menuGroup.updateMenuGroup](http://api.java110.com:8008/api/menuGroup.updateMenuGroup)
``` javascript
请求头信息:
Content-Type:application/json
USER_ID:1234
APP_ID:8000418002
TRANSACTION_ID:10029082726
REQ_TIME:20181113225612
SIGN:aabdncdhdbd878sbdudn898
请求报文:
{
    gId: "802019110855900043"
    name: "设备管理"
    icon: "fa fa-globe"
    label: "HOT"
    seq: "10"
    description: "ada"
    communityId: "7020181217000001"
}
返回报文:
成功
```