切换主题
🔄 版本检测接口
📖 接口概述
版本检测接口用于检查应用是否有新版本可用,支持多平台、多渠道的版本管理。
🔗 接口信息
基本信息
项目 | 说明 |
---|---|
请求方式 | GET |
接口路径 | /checkVersion |
需要认证 | 否 |
访问地址
直接访问
httphttp://127.0.0.1:9720/checkVersion
网关访问
httphttps://127.0.0.1:8080/api/app-upgrade/checkVersion
📝 请求参数
参数名 | 类型 | 必填 | 说明 | 示例值 | 备注 |
---|---|---|---|---|---|
appNo | String | 是 | 应用编号 | DEMO | 应用唯一标识 |
channelNo | String | 是 | 渠道编号 | NONE | 分发渠道标识 |
platform | String | 是 | 平台类型 | ANDROID | 支持 ANDROID/IOS |
version | String | 是 | 当前版本号 | 1.2.1 | 遵循语义化版本 |
参数说明
platform 平台类型
ANDROID
: Android平台IOS
: iOS平台
version 版本号格式
- 格式:主版本号.次版本号.修订号
- 示例:
1.2.1
- 规范:遵循语义化版本 2.0.0
📤 请求示例
直接访问
http
GET http://127.0.0.1:9720/checkVersion?appNo=demo&channelNo=none&platform=ANDROID&version=1.2.0
网关访问
http
GET https://127.0.0.1:8080/api/app-upgrade/checkVersion?appNo=demo&channelNo=none&platform=ANDROID&version=1.2.0
📥 响应结果
响应参数
json
{
"code": 0, // 状态码:0成功,其他失败
"successful": true, // 请求是否成功
"msg": null, // 错误信息
"data": { // 返回数据,null表示无更新
"version": "1.2.2", // 最新版本号
"url": "https://example.com/app.apk", // 下载地址
"forceUpdate": 0, // 是否强制更新:0否,1是
"updateContent": "更新说明" // 更新内容
}
}
响应字段说明
字段 | 类型 | 说明 | 示例值 |
---|---|---|---|
code | Integer | 状态码 | 0 |
successful | Boolean | 是否成功 | true |
msg | String | 错误信息 | null |
data | Object | 版本信息 | {...} |
data 对象字段
字段 | 类型 | 说明 | 示例值 |
---|---|---|---|
version | String | 最新版本号 | 1.2.2 |
url | String | 下载地址 | https://example.com/app.apk |
forceUpdate | Integer | 强制更新 | 0 |
updateContent | String | 更新说明 | 修复已知问题 |
⚠️ 错误码说明
错误码 | 说明 | 处理建议 |
---|---|---|
0 | 成功 | - |
💡 最佳实践
版本检查时机
- 应用启动时
- 定期后台检查
- 用户手动检查
错误处理
- 实现请求重试机制
- 缓存上次检查结果
- 添加超时处理
更新处理
- 强制更新时禁止跳过
- 下载前检查存储空间
- 显示更新进度
注意事项
- 建议使用HTTPS协议
- 注意请求频率限制
- 处理网络异常情况
- 关注用户体验