管理员信息
1. 接口定位
- 接口名称: 获取管理员信息
- 所属域: admin/account
- 业务目标: 返回当前登录管理员在管理库中的资料
2. 请求定义
- Method:
POST - Path:
/account/info - Content-Type: 推荐
application/json - operationID: 必填,请通过 Header
operationID传入 - 鉴权: 需要 Header
token,且必须是管理员 token - 幂等性: 幂等
3. 请求参数
Header 参数
| 字段 | 必填 | 类型 | 说明 |
|---|---|---|---|
| operationID | 是 | string | 链路追踪 ID |
| token | 是 | string | 管理员 token |
Body 参数
- 无业务参数,请传空对象
{}。
4. 响应结构
通用响应包裹
| 字段 | 类型 | 说明 |
|---|---|---|
| errCode | int | 错误码,0 表示成功 |
| errMsg | string | 错误简述 |
| errDlt | string | 错误详情 |
| data | object | 业务数据 |
data 字段
| 字段 | 类型 | 说明 |
|---|---|---|
| account | string | 管理员账号 |
| password | string | 管理员密码;当前实现会直接返回库中值 |
| faceURL | string | 管理员头像 |
| nickname | string | 管理员昵称 |
| userID | string | 管理员用户 ID |
| level | int32 | 管理员等级 |
| createTime | int64 | 创建时间,Unix 毫秒时间戳 |
5. 业务规则
- 中间件会先解析 Header
token,并校验其userType = AdminUser。 - RPC 层通过 token 中的管理员
userID读取当前管理员资料。 - 当前实现会把
password字段原样放到响应里,这是代码真实行为。
6. 错误码与失败场景
| 错误码 | 场景 | 典型报错 |
|---|---|---|
| 1001 | 未传 token | token is empty |
| 1001 | token 类型不是管理员 | token type error |
| - | token 无法解析或已失效 | 由 ParseToken 链路返回 |
| - | 当前管理员记录不存在 | 由数据库层返回 |
7. 示例
fetch 请求示例
javascript
fetch("http://localhost:10009/account/info", {
method: "POST",
headers: {
operationID: "550e8400-e29b-41d4-a716-446655440102",
token: "eyJhbGciOi...",
"Content-Type": "application/json",
},
body: JSON.stringify({}),
})
.then((res) => res.json())
.then((data) => console.log(data));请求示例(JSON)
json
{}成功响应示例
json
{
"errCode": 0,
"errMsg": "",
"errDlt": "",
"data": {
"account": "root_admin",
"password": "OpenIM@123",
"faceURL": "https://example.com/admin.png",
"nickname": "System Admin",
"userID": "1000000001",
"level": 100,
"createTime": 1774905600000
}
}失败响应示例
json
{
"errCode": 1001,
"errMsg": "ArgsError",
"errDlt": "token is empty"
}8. 时序流程
- 中间件校验 Header
token是否存在且属于管理员。 - RPC 层从 token 上下文中取当前管理员
userID。 - 查询管理员库并组装资料响应。
- 返回当前管理员信息。
9. 变更记录
- 2026-03-31: 首版发布,基于 admin 中间件、
GetAdminInfoReq/GetAdminInfoResp协议与 admin RPC 实现补全文档。