模拟接口返回数据结构详细说明
接口结构:
字段名 | 数据类型 | 说明 |
---|---|---|
code | Integer | 状态码 默认 200:成功,0:失败 |
data | Object | 数据内容 |
msg | string | 信息 |
1. 首页数据接口返回字段详细说明
字段名 | 类型 | 是否必传 | 说明 |
---|---|---|---|
code | int | 是 | 状态码,200 表示调用成功 |
msg | string | 否,是扩展字段 | 返回信息,"调用成功" 表示请求成功 |
data | object | 是 | 返回的数据对象 |
data.tabBarCode | string | 是 | 标签栏代码,"NOVEL" 表示小说分类 |
data.tabBarTitle | string | 是 | 标签栏标题,"小说" 表示当前页面展示的是小说内容 |
data.bannerVos | array | 是 | 轮播图列表,包含多个轮播图信息 |
data.bannerVos.id | int | 否,是扩展字段 | 轮播图唯一标识 |
data.bannerVos.remove | boolean | 否,是扩展字段 | 是否移除,false 表示不移除 |
data.bannerVos.imageLink | string | 是 | 轮播图图片链接 |
data.bannerVos.jumpUrl | string | 是 | 轮播图跳转链接 |
data.bannerVos.type | string | 是 | 轮播图类型,"NOVEL" 表示小说相关 |
data.bannerVos.businessAd | string | 是 | 业务广告类型,"IN_AD" 表示内部广告 |
data.bannerVos.channel | string | 否,是扩展字段 | 渠道,"OTHER" 表示其他渠道,"FEMALE" 表示女性频道 |
data.xsList | array | 是 | 限时精选小说列表,包含多本小说信息 |
data.xsList.id | int | 是 | 小说唯一标识 |
data.xsList.title | string | 是 | 小说标题 |
data.xsList.categoryId | int | 否,是扩展字段 | 小说分类 ID,扩展字段 |
data.xsList.categoryName | string | 否,是扩展字段 | 小说分类名称,如 "经商种田" |
data.xsList.author | string | 是 | 小说作者 |
data.xsList.coverImg | string | 是 | 小说封面图片链接 |
data.xsList.intro | string | 是 | 小说简介 |
data.xsList.labelInfo | string | 否,是扩展字段 | 小说标签信息,如 "穿越#种田#农家女#空间#虐渣#逆袭" |
data.xsList.serialStatus | string | 否,是扩展字段 | 小说连载状态,"FINISH" 表示已完结,扩展字段 |
data.xsList.latelyFollowerS | int | 否,是扩展字段 | 最近关注人数,扩展字段 |
data.xsList.score | string | 否,是扩展字段 | 小说评分,如 默认值 "9.8" |
data.xsList.words | int | 否,是扩展字段 | 小说字数,扩展字段 |
data.xsList.dayUpdateCount | int | 否,是扩展字段 | 每日更新字数 |
data.xsList.createTime | string | 否,是扩展字段 | 小说创建时间,格式为 "YYYY-MM-DD HH:mm:ss" |
data.xsList.lastModified | string | 否,是扩展字段 | 小说最后修改时间,格式为 "YYYY-MM-DD HH:mm:ss" |
data.xsList.adPages | int | 否,是扩展字段 | 广告页数 |
data.xsList.addShelf | boolean | 是 | 是否加入书架,false 表示未加入 |
data.xsList.subjectType | string | 是 | 主题类型,"NOVEL" 表示小说 |
data.pzList | array | 否,是扩展字段 | 其他列表,当前为空 |
data.pages | object | 否,是扩展字段 | 更多电子书的分页信息,演示环境不是必填字段,演示环境为空 |
data.pages.total | int | 否,是扩展字段 | 总记录数 |
data.pages.page | int | 否,是扩展字段 | 当前页码 |
data.pages.size | int | 否,是扩展字段 | 每页大小 |
data.pages.totalPages | int | 否,是扩展字段 | 总页数 |
data.pages.list | array | 否,是扩展字段 | 当前页数据列表,当前为空 |
2. 章节目录内容接口返回字段详细说明
字段名 | 类型 | 是否必传 | 说明 |
---|---|---|---|
code | int | 是 | 状态码,200 表示调用成功 |
msg | string | 否,是扩展字段 | 返回信息,"调用成功" 表示请求成功 |
data | object | 是 | 返回的数据对象 |
data.chapters | array | 是 | 章节列表,包含多个章节信息 |
data.chapters.chapterCover | string | 否,是扩展字段 | 章节封面图片链接,当前为空 |
data.chapters.unreadble | boolean | 否,是扩展字段 | 是否不可读,false 表示可读 |
data.chapters.link | string | 否,是扩展字段 | 章节链接,当前为空 |
data.chapters.sort | int | 否,是扩展字段 | 章节排序,0 表示默认排序 |
data.chapters.chapterNumber | int | 是 | 章节编号,如 1 表示第 1 章 |
data.chapters.title | string | 是 | 章节标题,如 "第1章 穿越农家女" |
data.chapters.isVip | boolean | 否,是扩展字段 | 是否 VIP 章节,false 表示非 VIP |
data.chapters.isLock | boolean | 否,是扩展字段 | 是否锁定,false 表示未锁定 |
data.chapters.currency | int | 否,是扩展字段 | 章节所需货币,0 表示免费 |
data.chapters.id | string | 是 | 章节唯一标识 |
data.chapters.time | int | 是 | 章节时间戳,0 表示无时间信息 |
3. 章节内容接口返回字段详细说明
字段名 | 是否必传 | 说明 |
---|---|---|
id | 是 | 章节唯一标识,必须唯一且需要传递 |
bookId | 是 | 书籍唯一标识 |
title | 是 | 章节标题 |
content | 是 | 章节内容 |
words | 是 | 字数可以通过内容计算得到 |
currency | 否,是扩展字段 | 可以默认值为 0 表示免费 |
sort | 是 | 默认排序可以默认为 0 |
chapterNumber | 是 | 必须提供章节编号 |
createTime | 是 | 创建时间 |
lastModified | 是 | 更新时间 |
time | 是 | 时间戳可以由系统自动生成 |
chapterCover | 否,是扩展字段 | 如果没有封面图片,可以为空 |
lock | 否,是扩展字段 | 默认可以为 false,表示未锁定 |
vip | 是 | 如果不是 VIP 章节,可以为 false,也是扩展字段,建议保留并且传递 |
4. 书籍的基本信息接口返回字段详细说明
字段名 | 类型 | 是否必传 | 说明 |
---|---|---|---|
code | int | 是 | 状态码,200 表示调用成功 |
msg | string | 否,是扩展字段 | 返回信息,"调用成功" 表示请求成功 |
data | object | 是 | 返回的数据对象 |
data.bookInfo | object | 是 | 书籍信息对象,包含书籍的详细信息 |
data.bookInfo.id | int | 是 | 书籍唯一标识 |
data.bookInfo.title | string | 是 | 书籍标题,值为章节的名称 |
data.bookInfo.categoryId | int | 是 | 书籍类别ID |
data.bookInfo.categoryName | string | 是 | 书籍类别名称,值为 "经商种田" |
data.bookInfo.authorId | int | 否,是扩展字段 | 作者ID |
data.bookInfo.author | string | 是 | 作者名称,值为作者名字 |
data.bookInfo.coverImg | string | 是 | 书籍封面图片链接 |
data.bookInfo.intro | string | 否,是扩展字段 | 书籍简介,描述书籍的主要内容 |
data.bookInfo.labelInfo | string | 否,是扩展字段 | 书籍标签信息,多个标签以#分隔 |
data.bookInfo.sellStatus | string | 否,是扩展字段 | 书籍的销售状态,UP 表示在售,DOWN 表示下架 |
data.bookInfo.sensitiveStatus | string | 否,是扩展字段 | 敏感状态,IN_SENSITIVE 表示敏感 |
data.bookInfo.serialStatus | string | 否,是扩展字段 | 连载状态,FINISH 表示已完结 |
data.bookInfo.copyrightStatus | string | 否,是扩展字段 | 版权状态,REPRINT 表示转载 |
data.bookInfo.source | string | 否,是扩展字段 | 书籍来源,值为书籍平台来源 |
data.bookInfo.chapterPrice | int | 否,是扩展字段 | 每章价格,值为 "0" 表示免费 |
data.bookInfo.price | int | 否,是扩展字段 | 书籍总价格,值为 "0" 表示免费 |
data.bookInfo.latelyFollowerS | int | 否,是扩展字段 | 最近关注人数,表示书籍的关注量 |
data.bookInfo.totalFollower | int | 否,是扩展字段 | 总关注人数,表示书籍的总关注量 |
data.bookInfo.retentionRatio | string | 否,是扩展字段 | 留存率,表示用户持续关注的比例 |
data.bookInfo.nextRetentionRatio | string | 否,是扩展字段 | 下一期留存率,表示预测的用户持续关注比例 |
data.bookInfo.monthRetentionRatio | string | 否,是扩展字段 | 月度留存率,表示该月的用户持续关注比例 |
data.bookInfo.lastChapterId | string | 是 | 上一章节ID,表示最后一章节的唯一标识 |
data.bookInfo.lastChapterName | string | 是 | 上一章节名称,值为 "第51章 大结局" |
data.bookInfo.score | string | 否,是扩展字段 | 书籍评分,表示用户对书籍的评分 |
data.bookInfo.words | int | 否,是扩展字段 | 书籍字数,表示书籍的总字数 |
data.bookInfo.totalChapters | int | 是 | 总章节数,表示书籍的章节总数 |
data.bookInfo.dayUpdateCount | int | 否,是扩展字段 | 每日更新章节数,表示每天更新的章节数量 |
data.bookInfo.createTime | string | 否,是扩展字段 | 书籍创建时间,格式为 "YYYY-MM-DD HH:mm:ss" |
data.bookInfo.lastModified | string | 否,是扩展字段 | 最后修改时间,格式为 "YYYY-MM-DD HH:mm:ss" |
data.bookInfo.adPages | int | 是 | 广告页数,表示书籍中广告页的数量 |
data.bookInfo.addShelf | boolean | 是 | 是否已加入书架,false 表示未加入书架 |
data.bookInfo.subjectType | string | 是 | 书籍类型,值为 "NOVEL" 表示小说,目前主要用于历史记录存储,可以根据自身业务扩展,详见historyMixin.js |
data.interestBooks | array | 否,是扩展字段 | 推荐书籍列表,包含多个推荐书籍的信息 |