Appearance
漫游首页聚合接口
漫游首页聚合接口
基本信息
- 接口名称:漫游首页聚合
- 接口用途:获取景区介绍、路线列表、景点列表
- 调用方:小程序前端
- 请求方式:
GET - 请求路径:
/roaming/overview - 请求头要求:可选登录态
- 幂等要求:否
请求参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| withUserProgress | bool | 否 | 是否返回用户打卡与徽章状态 |
返回结构
| 参数 | 类型 | 说明 |
|---|---|---|
| scenicIntro | object | 景区介绍 |
| routes | array | 路线列表 |
| spots | array | 景点列表 |
成功示例
{"code":"0","message":"ok","data":{"scenicIntro":{"title":"西湖景区"},"routes":[{"routeId":"R001"}],"spots":[{"spotId":"S001"}]}}
失败示例
错误码
| 错误码 | 说明 |
|---|---|
| A0004 | 景区信息加载失败,请稍后再试 |
同步与缓存策略
- 前后端同步规则:进入漫游页时回源
- 缓存/刷新策略:缓存 5 分钟
- 一致性要求:最终一致
说明
该接口用于漫游首页首屏聚合数据加载,统一返回:
- 景区介绍
scenicIntro - 路线列表
routes - 景点列表
spots
当传入 withUserProgress=true 时,可附带返回用户打卡与徽章状态,适用于已登录用户场景。
