更新管理员资料
1. 接口定位
- 接口名称: 更新管理员资料
- 所属域: admin/account
- 业务目标: 更新当前登录管理员在 admin 服务中的资料,并尝试同步默认 OpenIM 管理员资料中的昵称和头像
2. 请求定义
- Method:
POST - Path:
/account/update - Content-Type: 推荐
application/json - operationID: 必填,请通过 Header
operationID传入 - 鉴权: 需要 Header
token,且必须是管理员 token - 幂等性: 对相同更新内容近似幂等
3. 请求参数
Header 参数
| 字段 | 必填 | 类型 | 说明 |
|---|---|---|---|
| operationID | 是 | string | 链路追踪 ID |
| token | 是 | string | 管理员 token |
Body 参数
本接口使用 protobuf wrapper 字段;要表达“更新该字段”,需传对象形态 {"value": ...}。
| 字段 | 必填 | 类型 | 说明 |
|---|---|---|---|
| account | 否 | object | 账号更新对象,格式 { "value": "new_account" } |
| password | 否 | object | 密码更新对象,格式 { "value": "new_password" } |
| faceURL | 否 | object | 头像更新对象,格式 { "value": "https://..." } |
| nickname | 否 | object | 昵称更新对象,格式 { "value": "new name" } |
| level | 否 | object | 级别更新对象,格式 { "value": 80 } |
字段约束
- 至少要传一个可更新字段,否则返回
no update info。 account.value传空字符串会返回account is empty。password.value传空字符串会返回password is empty。nickname.value传空字符串会返回nickname is empty。faceURL.value允许传空字符串,表示更新为空值。
4. 响应结构
通用响应包裹
| 字段 | 类型 | 说明 |
|---|---|---|
| errCode | int | 错误码,0 表示成功 |
| errMsg | string | 错误简述 |
| errDlt | string | 错误详情 |
| data | object | 业务数据 |
data 字段
- 当前接口成功时返回空对象(API 层
GinSuccess(c, nil))。
5. 业务规则
- 中间件先校验管理员 token。
- RPC 层按当前 token 对应的管理员
userID更新自己的资料,不读取 body 中的userID。 - 当前实现允许更新
level字段;代码中没有额外的超级管理员限制。 - API 层在管理库更新成功后,会尝试把默认 OpenIM 管理员资料同步为返回的
nickname/faceURL。 - OpenIM 资料同步失败只会记录日志,不会让接口整体失败。
6. 错误码与失败场景
| 错误码 | 场景 | 典型报错 |
|---|---|---|
| 1001 | 未传 token | token is empty |
| 1001 | 未传任何可更新字段 | no update info |
| 1001 | account.value 为空 | account is empty |
| 1001 | password.value 为空 | password is empty |
| 1001 | nickname.value 为空 | nickname is empty |
| - | 当前管理员记录不存在 | 由数据库层返回 |
7. 示例
fetch 请求示例
javascript
fetch("http://localhost:10009/account/update", {
method: "POST",
headers: {
operationID: "550e8400-e29b-41d4-a716-446655440103",
token: "eyJhbGciOi...",
"Content-Type": "application/json",
},
body: JSON.stringify({
nickname: { value: "OpenIM Admin" },
faceURL: { value: "https://example.com/avatar-new.png" },
}),
})
.then((res) => res.json())
.then((data) => console.log(data));请求示例(JSON)
json
{
"nickname": {
"value": "OpenIM Admin"
},
"faceURL": {
"value": "https://example.com/avatar-new.png"
}
}成功响应示例
json
{
"errCode": 0,
"errMsg": "",
"errDlt": "",
"data": {}
}失败响应示例
json
{
"errCode": 1001,
"errMsg": "ArgsError",
"errDlt": "no update info"
}8. 时序流程
- 中间件校验管理员 token。
- 解析 wrapper 形式的更新字段。
- 将可更新字段转换为数据库 update map,并校验空值。
- 按当前管理员
userID更新管理库资料。 - 尝试同步默认 OpenIM 管理员昵称和头像。
- 返回统一成功响应。
9. 变更记录
- 2026-03-31: 首版发布,基于
AdminUpdateInfoReqwrapper 结构、admin RPC 更新逻辑和 API 层 OpenIM 同步逻辑补全文档。