编辑版本信息
1. 接口定位
- 接口名称: 编辑版本信息
- 所属域: admin/application
- 业务目标: 按版本记录 ID 局部更新应用版本信息
2. 请求定义
- Method:
POST - Path:
/application/update_version - Content-Type: 推荐
application/json - operationID: 必填,请通过 Header
operationID传入 - 鉴权: 需要 Header
token,且必须是管理员 token - 幂等性: 对相同更新内容重复提交可视为幂等
3. 请求参数
Header 参数
| 字段 | 必填 | 类型 | 说明 |
|---|---|---|---|
| operationID | 是 | string | 链路追踪 ID |
| token | 是 | string | 管理员 token |
Body 参数
| 字段 | 必填 | 类型 | 说明 |
|---|---|---|---|
| id | 是 | string | 目标版本记录的 Mongo ObjectID 十六进制字符串 |
| platform | 否 | object | wrapper 字段,存在时更新平台 |
| version | 否 | object | wrapper 字段,存在时更新版本号 |
| url | 否 | object | wrapper 字段,存在时更新下载地址 |
| text | 否 | object | wrapper 字段,存在时更新版本说明 |
| force | 否 | object | wrapper 字段,存在时更新强制升级标记 |
| latest | 否 | object | wrapper 字段,存在时更新最新版本标记 |
| hot | 否 | object | wrapper 字段,存在时更新热更标记 |
wrapper 字段说明
StringValue风格字段使用:{ "value": "new-value" }BoolValue风格字段使用:{ "value": true }
字段约束
- 当前协议层没有为本接口定义显式
Check()校验。 - RPC 层会强制校验
id是否可解析为 MongoObjectID,否则返回invalid id ...。 - 当前实现允许请求里不传任何可更新字段;此时更新字典为空,最终不会修改任何内容,但接口仍可能返回成功。
4. 响应结构
通用响应包裹
| 字段 | 类型 | 说明 |
|---|---|---|
| errCode | int | 错误码,0 表示成功 |
| errMsg | string | 错误简述 |
| errDlt | string | 错误详情 |
| data | object | 业务数据 |
data 字段
- 本接口成功时返回空对象(无业务字段)。
5. 业务规则
- 仅管理员可以调用。
- 服务端按 wrapper 字段是否存在决定哪些字段进入
$set更新。 - RPC 不会先查询版本记录是否存在,而是直接按
_id尝试更新。 - 若把
platform和version更新成已存在的组合,仍会触发数据库唯一索引冲突。
6. 错误码与失败场景
| 错误码 | 场景 | 典型报错 |
|---|---|---|
| 1001 | id 不是合法 ObjectID | invalid id ... |
| - | (platform, version) 更新冲突 | 由数据库唯一索引返回错误 |
| - | 数据库更新失败 | 由数据库层返回原始错误 |
7. 示例
fetch 请求示例
javascript
fetch("http://localhost:10009/application/update_version", {
method: "POST",
headers: {
operationID: "550e8400-e29b-41d4-a716-446655440702",
token: "eyJhbGciOi...",
"Content-Type": "application/json",
},
body: JSON.stringify({
id: "67ea5ef1b9f35d6a63717811",
text: { value: "security patch release" },
latest: { value: true },
hot: { value: false },
}),
})
.then((res) => res.json())
.then((data) => console.log(data));请求示例(JSON)
json
{
"id": "67ea5ef1b9f35d6a63717811",
"text": {
"value": "security patch release"
},
"latest": {
"value": true
},
"hot": {
"value": false
}
}成功响应示例
json
{
"errCode": 0,
"errMsg": "",
"errDlt": "",
"data": {}
}失败响应示例
json
{
"errCode": 1001,
"errMsg": "ArgsError",
"errDlt": "invalid id the provided hex string is not a valid ObjectID"
}8. 时序流程
- 中间件校验管理员 token。
- 解析
id为 MongoObjectID。 - 根据 wrapper 字段构造更新字典。
- 对匹配
_id的版本记录执行$set更新。 - 返回统一成功响应。
9. 变更记录
- 2026-03-31: 首版发布,基于应用版本局部更新与 ObjectID 解析逻辑补全文档。