miliqkmiliqk
指南
  • 1.X
  • 2.X
  • 3.X
版本差异
关于我们
指南
  • 1.X
  • 2.X
  • 3.X
版本差异
关于我们
  • 起步

    • 加 QQ 群交流反馈
    • 介绍
    • 安装
    • 配置
    • 快速上手
    • 内置样式
    • 注意事项
    • 扫码演示
    • 更新日志
  • 插件

    • 使用指南
    • 模拟数据

模拟接口返回数据结构详细说明

接口结构:

字段名数据类型说明
codeInteger状态码 默认 200:成功,0:失败
dataObject数据内容
msgstring信息

1. 首页数据接口返回字段详细说明

字段名类型是否必传说明
codeint是状态码,200 表示调用成功
msgstring否,是扩展字段返回信息,"调用成功" 表示请求成功
dataobject是返回的数据对象
data.tabBarCodestring是标签栏代码,"NOVEL" 表示小说分类
data.tabBarTitlestring是标签栏标题,"小说" 表示当前页面展示的是小说内容
data.bannerVosarray是轮播图列表,包含多个轮播图信息
data.bannerVos.idint否,是扩展字段轮播图唯一标识
data.bannerVos.removeboolean否,是扩展字段是否移除,false 表示不移除
data.bannerVos.imageLinkstring是轮播图图片链接
data.bannerVos.jumpUrlstring是轮播图跳转链接
data.bannerVos.typestring是轮播图类型,"NOVEL" 表示小说相关
data.bannerVos.businessAdstring是业务广告类型,"IN_AD" 表示内部广告
data.bannerVos.channelstring否,是扩展字段渠道,"OTHER" 表示其他渠道,"FEMALE" 表示女性频道
data.xsListarray是限时精选小说列表,包含多本小说信息
data.xsList.idint是小说唯一标识
data.xsList.titlestring是小说标题
data.xsList.categoryIdint否,是扩展字段小说分类 ID,扩展字段
data.xsList.categoryNamestring否,是扩展字段小说分类名称,如 "经商种田"
data.xsList.authorstring是小说作者
data.xsList.coverImgstring是小说封面图片链接
data.xsList.introstring是小说简介
data.xsList.labelInfostring否,是扩展字段小说标签信息,如 "穿越#种田#农家女#空间#虐渣#逆袭"
data.xsList.serialStatusstring否,是扩展字段小说连载状态,"FINISH" 表示已完结,扩展字段
data.xsList.latelyFollowerSint否,是扩展字段最近关注人数,扩展字段
data.xsList.scorestring否,是扩展字段小说评分,如 默认值 "9.8"
data.xsList.wordsint否,是扩展字段小说字数,扩展字段
data.xsList.dayUpdateCountint否,是扩展字段每日更新字数
data.xsList.createTimestring否,是扩展字段小说创建时间,格式为 "YYYY-MM-DD HH:mm:ss"
data.xsList.lastModifiedstring否,是扩展字段小说最后修改时间,格式为 "YYYY-MM-DD HH:mm:ss"
data.xsList.adPagesint否,是扩展字段广告页数
data.xsList.addShelfboolean是是否加入书架,false 表示未加入
data.xsList.subjectTypestring是主题类型,"NOVEL" 表示小说
data.pzListarray否,是扩展字段其他列表,当前为空
data.pagesobject否,是扩展字段更多电子书的分页信息,演示环境不是必填字段,演示环境为空
data.pages.totalint否,是扩展字段总记录数
data.pages.pageint否,是扩展字段当前页码
data.pages.sizeint否,是扩展字段每页大小
data.pages.totalPagesint否,是扩展字段总页数
data.pages.listarray否,是扩展字段当前页数据列表,当前为空

2. 章节目录内容接口返回字段详细说明

字段名类型是否必传说明
codeint是状态码,200 表示调用成功
msgstring否,是扩展字段返回信息,"调用成功" 表示请求成功
dataobject是返回的数据对象
data.chaptersarray是章节列表,包含多个章节信息
data.chapters.chapterCoverstring否,是扩展字段章节封面图片链接,当前为空
data.chapters.unreadbleboolean否,是扩展字段是否不可读,false 表示可读
data.chapters.linkstring否,是扩展字段章节链接,当前为空
data.chapters.sortint否,是扩展字段章节排序,0 表示默认排序
data.chapters.chapterNumberint是章节编号,如 1 表示第 1 章
data.chapters.titlestring是章节标题,如 "第1章 穿越农家女"
data.chapters.isVipboolean否,是扩展字段是否 VIP 章节,false 表示非 VIP
data.chapters.isLockboolean否,是扩展字段是否锁定,false 表示未锁定
data.chapters.currencyint否,是扩展字段章节所需货币,0 表示免费
data.chapters.idstring是章节唯一标识
data.chapters.timeint是章节时间戳,0 表示无时间信息

3. 章节内容接口返回字段详细说明

字段名是否必传说明
id是章节唯一标识,必须唯一且需要传递
bookId是书籍唯一标识
title是章节标题
content是章节内容
words是字数可以通过内容计算得到
currency否,是扩展字段可以默认值为 0 表示免费
sort是默认排序可以默认为 0
chapterNumber是必须提供章节编号
createTime是创建时间
lastModified是更新时间
time是时间戳可以由系统自动生成
chapterCover否,是扩展字段如果没有封面图片,可以为空
lock否,是扩展字段默认可以为 false,表示未锁定
vip是如果不是 VIP 章节,可以为 false,也是扩展字段,建议保留并且传递

4. 书籍的基本信息接口返回字段详细说明

字段名类型是否必传说明
codeint是状态码,200 表示调用成功
msgstring否,是扩展字段返回信息,"调用成功" 表示请求成功
dataobject是返回的数据对象
data.bookInfoobject是书籍信息对象,包含书籍的详细信息
data.bookInfo.idint是书籍唯一标识
data.bookInfo.titlestring是书籍标题,值为章节的名称
data.bookInfo.categoryIdint是书籍类别ID
data.bookInfo.categoryNamestring是书籍类别名称,值为 "经商种田"
data.bookInfo.authorIdint否,是扩展字段作者ID
data.bookInfo.authorstring是作者名称,值为作者名字
data.bookInfo.coverImgstring是书籍封面图片链接
data.bookInfo.introstring否,是扩展字段书籍简介,描述书籍的主要内容
data.bookInfo.labelInfostring否,是扩展字段书籍标签信息,多个标签以#分隔
data.bookInfo.sellStatusstring否,是扩展字段书籍的销售状态,UP 表示在售,DOWN 表示下架
data.bookInfo.sensitiveStatusstring否,是扩展字段敏感状态,IN_SENSITIVE 表示敏感
data.bookInfo.serialStatusstring否,是扩展字段连载状态,FINISH 表示已完结
data.bookInfo.copyrightStatusstring否,是扩展字段版权状态,REPRINT 表示转载
data.bookInfo.sourcestring否,是扩展字段书籍来源,值为书籍平台来源
data.bookInfo.chapterPriceint否,是扩展字段每章价格,值为 "0" 表示免费
data.bookInfo.priceint否,是扩展字段书籍总价格,值为 "0" 表示免费
data.bookInfo.latelyFollowerSint否,是扩展字段最近关注人数,表示书籍的关注量
data.bookInfo.totalFollowerint否,是扩展字段总关注人数,表示书籍的总关注量
data.bookInfo.retentionRatiostring否,是扩展字段留存率,表示用户持续关注的比例
data.bookInfo.nextRetentionRatiostring否,是扩展字段下一期留存率,表示预测的用户持续关注比例
data.bookInfo.monthRetentionRatiostring否,是扩展字段月度留存率,表示该月的用户持续关注比例
data.bookInfo.lastChapterIdstring是上一章节ID,表示最后一章节的唯一标识
data.bookInfo.lastChapterNamestring是上一章节名称,值为 "第51章 大结局"
data.bookInfo.scorestring否,是扩展字段书籍评分,表示用户对书籍的评分
data.bookInfo.wordsint否,是扩展字段书籍字数,表示书籍的总字数
data.bookInfo.totalChaptersint是总章节数,表示书籍的章节总数
data.bookInfo.dayUpdateCountint否,是扩展字段每日更新章节数,表示每天更新的章节数量
data.bookInfo.createTimestring否,是扩展字段书籍创建时间,格式为 "YYYY-MM-DD HH:mm:ss"
data.bookInfo.lastModifiedstring否,是扩展字段最后修改时间,格式为 "YYYY-MM-DD HH:mm:ss"
data.bookInfo.adPagesint是广告页数,表示书籍中广告页的数量
data.bookInfo.addShelfboolean是是否已加入书架,false 表示未加入书架
data.bookInfo.subjectTypestring是书籍类型,值为 "NOVEL" 表示小说,目前主要用于历史记录存储,可以根据自身业务扩展,详见historyMixin.js
data.interestBooksarray否,是扩展字段推荐书籍列表,包含多个推荐书籍的信息
Last Updated:
Contributors: tuonioooo
关注公众号程序猿的游戏开源工具密圈 获取更多内容