Skip to content

发布新版本

1. 接口定位

  • 接口名称: 发布新版本
  • 所属域: admin/application
  • 业务目标: 新增一条应用版本记录,供客户端查询最新版本或分页拉取版本列表

2. 请求定义

  • Method: POST
  • Path: /application/add_version
  • Content-Type: 推荐 application/json
  • operationID: 必填,请通过 Header operationID 传入
  • 鉴权: 需要 Header token,且必须是管理员 token
  • 幂等性: 非幂等;同平台同版本受唯一索引约束,重复发布会失败

3. 请求参数

Header 参数

字段必填类型说明
operationIDstring链路追踪 ID
tokenstring管理员 token

Body 参数

字段必填类型说明
platformstring平台标识,如 iosandroid
versionstring版本号
urlstring版本下载地址
textstring版本说明
forcebool是否强制升级
latestbool是否标记为最新版本
hotbool是否标记为热更

字段约束

  • 当前协议层没有为本接口定义显式 Check() 校验。
  • RPC 层会直接使用请求字段落库,不再补额外默认值。
  • MongoDB 对 (platform, version) 建有唯一索引,同平台相同版本不能重复添加。

4. 响应结构

通用响应包裹

字段类型说明
errCodeint错误码,0 表示成功
errMsgstring错误简述
errDltstring错误详情
dataobject业务数据

data 字段

  • 本接口成功时返回空对象(无业务字段)。

5. 业务规则

  • 仅管理员可以调用。
  • 服务端会生成新的 Mongo ObjectID 作为版本记录主键。
  • createTime 使用服务端当前时间,不接受客户端传入。
  • 新版本发布后即可被 /application/latest_version/application/page_versions 查询到。

6. 错误码与失败场景

错误码场景典型报错
-(platform, version) 冲突由数据库唯一索引返回错误
-数据库写入失败由数据库层返回原始错误
-token 无效或非管理员由鉴权中间件/管理员校验返回

7. 示例

fetch 请求示例

javascript
fetch("http://localhost:10009/application/add_version", {
  method: "POST",
  headers: {
    operationID: "550e8400-e29b-41d4-a716-446655440701",
    token: "eyJhbGciOi...",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    platform: "ios",
    version: "1.2.0",
    url: "https://example.com/downloads/openim-ios-1.2.0.ipa",
    text: "bug fixes and performance improvements",
    force: false,
    latest: true,
    hot: false,
  }),
})
  .then((res) => res.json())
  .then((data) => console.log(data));

请求示例(JSON)

json
{
  "platform": "ios",
  "version": "1.2.0",
  "url": "https://example.com/downloads/openim-ios-1.2.0.ipa",
  "text": "bug fixes and performance improvements",
  "force": false,
  "latest": true,
  "hot": false
}

成功响应示例

json
{
  "errCode": 0,
  "errMsg": "",
  "errDlt": "",
  "data": {}
}

8. 时序流程

  1. 中间件校验管理员 token。
  2. 组装应用版本记录并生成新的 ObjectID
  3. 将版本信息写入 application 集合。
  4. 返回统一成功响应。

9. 变更记录

  • 2026-03-31: 首版发布,基于应用版本新增与数据库唯一索引逻辑补全文档。