丁小岩
1 year ago
4 changed files with 303 additions and 0 deletions
@ -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": {} |
|||
} |
|||
``` |
|||
|
|||
|
@ -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": {} |
|||
} |
|||
``` |
|||
|
|||
|
@ -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": {} |
|||
} |
|||
``` |
|||
|
|||
|
@ -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": {} |
|||
} |
|||
``` |
|||
|
|||
|
Loading…
Reference in new issue