Skip to content

首页聚合数据接口

概述

首页聚合数据接口用于返回首页展示所需的聚合内容,包括 Banner、公告、天气缩略、浮窗角标、漫游入口摘要

  • 接口名称:首页聚合数据
  • 接口用途:返回首页 Banner、公告、天气缩略、浮窗角标、漫游入口摘要
  • 调用方:小程序前端
  • 请求方式GET
  • 请求路径/home/aggregate
  • 请求头要求:无;登录态可选

请求参数

参数类型必填说明
withUserStatebool是否返回登录态相关数据

返回参数

参数类型说明
bannersarrayBanner 列表
weatherBriefobject天气缩略
topNoticeobject顶部公告
messageUnreadCountint未读消息数
roamingEntryobject漫游入口摘要

成功响应示例

{"code":"0","message":"ok","data":{"banners":[],"weatherBrief":{"temperature":"21C"},"topNotice":{"title":"今日公告"},"messageUnreadCount":2,"roamingEntry":{"title":"西湖漫游"}}}

失败响应示例

错误码

错误码说明
A0004首页数据加载失败,请稍后重试

接口约束

项目说明
幂等要求
前后端同步规则下拉刷新强制回源
缓存/刷新策略本地缓存 5 分钟,页面显示时可优先读缓存再回源
一致性要求最终一致

实现说明

  • 接口为首页聚合型接口,适合减少前端多次请求。
  • 支持可选登录态数据返回,由 withUserState 控制。
  • 页面展示时建议优先读取本地缓存,再执行回源更新。
  • 用户执行下拉刷新时,前端应强制回源获取最新数据。

谷子科技知识库平台 - 多格式摄入、受控编译、岗位隔离问答