From 498226eeeb4aa3b35d6265cb63bce5f213c4201e Mon Sep 17 00:00:00 2001 From: "Cola.Ding" Date: Wed, 28 Jun 2023 10:53:10 +0800 Subject: [PATCH] =?UTF-8?q?=E8=B4=A6=E5=8F=B7=E6=A8=A1=E5=9D=97=E6=96=87?= =?UTF-8?q?=E6=A1=A3=E6=B7=BB=E5=8A=A0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- mes/账号/修改账号.md | 74 +++++++++++++++++++++++++++++ mes/账号/修改账号密码.md | 72 ++++++++++++++++++++++++++++ mes/账号/新增账号.md | 76 ++++++++++++++++++++++++++++++ mes/账号/用户信息列表.md | 81 ++++++++++++++++++++++++++++++++ 4 files changed, 303 insertions(+) create mode 100644 mes/账号/修改账号.md create mode 100644 mes/账号/修改账号密码.md create mode 100644 mes/账号/新增账号.md create mode 100644 mes/账号/用户信息列表.md diff --git a/mes/账号/修改账号.md b/mes/账号/修改账号.md new file mode 100644 index 0000000..e5eaa7b --- /dev/null +++ b/mes/账号/修改账号.md @@ -0,0 +1,74 @@ +### 修改账号 +此接口用于给mes修改账号昵称或启用状态。 +此接口需要认证,详情请查看《认证方式》。 + +--- + +### 基本信息 +方法:POST +URL: http://localhost:8033/open/editUser + +--- + +### 请求 + +__请求参数__ + +| 参数名 | 类型 | 必填 | 说明 | +| :-- | :-- | :-- | :-- | +| profile | String | 是 | 厂区配置profile | +| UserName | String | 是 | 用户名,仅小写,英文与数字 | +| Nick | String | 否 | 昵称 | +| IsActive | Bool | 否 | 是否启用 true:是|false:否 | + +__请求示例:__ +``` + +{ + { + "data":{ + "profile": "测试", + "UserName":"0901001", + "Nick":"赵云", + "IsActive":true + } + } +} + +```` + +--- + +### 响应 +__响应字段__ +| 字段 | 类型 | 说明 | +| :-- | :-- | :-- | +| clock | string | 当前服务器时钟。 | +| status | string | 状态,ok:成功,error:错误,exception:异常 | +| data | object | 成功后返回具体内容 | + +__data:__ +| 字段 | 类型 | 说明 | +| :-- | :-- | :-- | + +``` +{ + "clock": "2023-06-25 20:00:00.000", + "status": "ok", + "data": { + + } +} + +``` +__出现错误信息响应__ +``` +{ + "clock": "2023-06-25 20:00:00.000", + "status": "error", + "message": "用户名已存在", + "data": {} +} +``` + + diff --git a/mes/账号/修改账号密码.md b/mes/账号/修改账号密码.md new file mode 100644 index 0000000..dabb6ab --- /dev/null +++ b/mes/账号/修改账号密码.md @@ -0,0 +1,72 @@ +### 修改账号密码 +此接口用于给mes修改账号密码。 +此接口需要认证,详情请查看《认证方式》。 + +--- + +### 基本信息 +方法:POST +URL: http://localhost:8033/open/editUserPwd + +--- + +### 请求 + +__请求参数__ + +| 参数名 | 类型 | 必填 | 说明 | +| :-- | :-- | :-- | :-- | +| profile | String | 是 | 厂区配置profile | +| UserName | String | 是 | 用户名,仅小写,英文与数字 | +| Password | String | 是 | 密码 | + +__请求示例:__ +``` + +{ + { + "data":{ + "profile": "测试", + "UserName":"0901001", + "Password":"1441qfda" + } + } +} + +```` + +--- + +### 响应 +__响应字段__ +| 字段 | 类型 | 说明 | +| :-- | :-- | :-- | +| clock | string | 当前服务器时钟。 | +| status | string | 状态,ok:成功,error:错误,exception:异常 | +| data | object | 成功后返回具体内容 | + +__data:__ +| 字段 | 类型 | 说明 | +| :-- | :-- | :-- | + +``` +{ + "clock": "2023-06-25 20:00:00.000", + "status": "ok", + "data": { + + } +} + +``` +__出现错误信息响应__ +``` +{ + "clock": "2023-06-25 20:00:00.000", + "status": "error", + "message": "用户名已存在", + "data": {} +} +``` + + diff --git a/mes/账号/新增账号.md b/mes/账号/新增账号.md new file mode 100644 index 0000000..36039fa --- /dev/null +++ b/mes/账号/新增账号.md @@ -0,0 +1,76 @@ +### 新增账号 +此接口用于给mes创建账号。 +此接口需要认证,详情请查看《认证方式》。 + +--- + +### 基本信息 +方法:POST +URL: http://localhost:8033/open/addUser + +--- + +### 请求 + +__请求参数__ + +| 参数名 | 类型 | 必填 | 说明 | +| :-- | :-- | :-- | :-- | +| profile | String | 是 | 厂区配置profile | +| UserName | String | 是 | 用户名,仅小写,英文与数字 | +| Nick | String | 是 | 昵称 | +| Password | String | 是 | 密码 | +| IsActive | Bool | 是 | 是否启用 true:是|false:否 | + +__请求示例:__ +``` + +{ + { + "data":{ + "profile": "测试", + "UserName":"0901001", + "Nick":"赵云", + "Password":"123456", + "IsActive":true + } + } +} + +```` + +--- + +### 响应 +__响应字段__ +| 字段 | 类型 | 说明 | +| :-- | :-- | :-- | +| clock | string | 当前服务器时钟。 | +| status | string | 状态,ok:成功,error:错误,exception:异常 | +| data | object | 成功后返回具体内容 | + +__data:__ +| 字段 | 类型 | 说明 | +| :-- | :-- | :-- | + +``` +{ + "clock": "2023-06-25 20:00:00.000", + "status": "ok", + "data": { + + } +} + +``` +__出现错误信息响应__ +``` +{ + "clock": "2023-06-25 20:00:00.000", + "status": "error", + "message": "用户名已存在", + "data": {} +} +``` + + diff --git a/mes/账号/用户信息列表.md b/mes/账号/用户信息列表.md new file mode 100644 index 0000000..272e06f --- /dev/null +++ b/mes/账号/用户信息列表.md @@ -0,0 +1,81 @@ +### 用户信息列表 +此接口用于查询mes的用户信息 +此接口需要认证,详情请查看《认证方式》。 + +--- + +### 基本信息 +方法:POST +URL: http://localhost:8033/open/userList + +--- + +### 请求 + +__请求参数__ + +| 参数名 | 类型 | 必填 | 说明 | +| :-- | :-- | :-- | :-- | +| profile | String | 是 | 厂区配置profile | +| UserName | String | 是 | 用户名,仅小写,英文与数字 | +| Nick | String | 是 | 昵称 | + +__请求示例:__ +``` + +{ + { + "data":{ + "profile": "测试", + "UserName":"0901001", + "Nick":"赵云" + } + } +} + +```` + +--- + +### 响应 +__响应字段__ +| 字段 | 类型 | 说明 | +| :-- | :-- | :-- | +| clock | string | 当前服务器时钟。 | +| status | string | 状态,ok:成功,error:错误,exception:异常 | +| data | object | 成功后返回具体内容 | + +__data.users:__ +| 字段 | 类型 | 说明 | +| :-- | :-- | :-- | +| userName | String | 用户名,仅小写,英文与数字 | +| nick | String | 昵称 | +| isActive | Bool | 是否启用 true:是|false:否 | + +``` +{ + "clock": "2023-06-25 20:00:00.000", + "status": "ok", + "data": { + "users":[ + { + "userName":"0901001", + "nick":"赵云", + "isActive":true + } + ] + } +} + +``` +__出现错误信息响应__ +``` +{ + "clock": "2023-06-25 20:00:00.000", + "status": "error", + "message": "用户名已存在", + "data": {} +} +``` + +