Skip to content

查询最新版本

1. 接口定位

  • 接口名称: 查询最新版本
  • 所属域: admin/application
  • 业务目标: 按平台获取当前排序意义上的“最新”版本记录

2. 请求定义

  • Method: POST
  • Path: /application/latest_version
  • Content-Type: 推荐 application/json
  • operationID: 必填,请通过 Header operationID 传入
  • 鉴权: 无
  • 幂等性: 幂等

3. 请求参数

Header 参数

字段必填类型说明
operationIDstring链路追踪 ID
tokenstring本接口无需 token

Body 参数

字段必填类型说明
platformstring平台标识
versionstring协议字段存在,但当前实现不会使用

字段约束

  • 当前协议层没有为本接口定义显式 Check() 校验。
  • 当前实现只按 platform 查询,version 请求字段会被忽略。

4. 响应结构

通用响应包裹

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

data 字段

字段类型说明
versionobject最新版本对象;未命中时为空

version 字段

字段类型说明
idstring版本记录 ID
platformstring平台标识
versionstring版本号
urlstring下载地址
textstring版本说明
forcebool是否强制升级
latestbool是否标记为最新
hotbool是否热更
createTimeint64创建时间,Unix 毫秒时间戳

5. 业务规则

  • 本接口无需鉴权,admin 与 chat 侧都可调用同一条业务链路。
  • 服务端查询条件只包含 platform
  • 排序规则来自数据库层:先按 latest 降序,再按 _id 降序;因此“最新版本”并不是按语义版本号比较,而是按这个固定排序取第一条。
  • 当数据库里没有对应平台版本时,接口返回成功,但 version 为空。

6. 错误码与失败场景

错误码场景典型报错
-数据库查询失败由数据库层返回原始错误

7. 示例

fetch 请求示例

javascript
fetch("http://localhost:10009/application/latest_version", {
  method: "POST",
  headers: {
    operationID: "550e8400-e29b-41d4-a716-446655440704",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    platform: "ios",
  }),
})
  .then((res) => res.json())
  .then((data) => console.log(data));

请求示例(JSON)

json
{
  "platform": "ios"
}

成功响应示例

json
{
  "errCode": 0,
  "errMsg": "",
  "errDlt": "",
  "data": {
    "version": {
      "id": "67ea5ef1b9f35d6a63717811",
      "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,
      "createTime": 1767225600000
    }
  }
}

未命中响应示例

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

8. 时序流程

  1. 读取请求中的 platform
  2. application 集合中按 platform 查询。
  3. latest desc, _id desc 排序取第一条记录。
  4. 命中则返回版本对象;未命中则返回空数据。

9. 变更记录

  • 2026-03-31: 首版发布,基于最新版本查询的真实排序规则补全文档。