apidoc.php 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743
  1. <?php
  2. /**
  3. * @api {get} common.public 公共参数说明
  4. * @apiVersion 1.0.0
  5. * @apiName common.public
  6. * @apiGroup Common
  7. *
  8. * @apiDescription 介绍公共参数
  9. *
  10. * @apiParam {Number} json 是否返回json格式的数据1为返回2为不返回
  11. * @apiParam {Number} signature 用于登录后的uid验证,每次都要传入,请登录后将这个值保存在本地
  12. * @apiParam {Number} pg 分页数,第几页,列表页瀑布流使用该参数
  13. *
  14. * @apiSuccess {Number} status 状态,1为有效2为无效
  15. * @apiSuccess {String} msg 请求的数据是否成功的提示
  16. * @apiSuccess {String} data 如果status为1,data有值
  17. * @apiSuccess {Object[]} page 分页信息
  18. * @apiSuccess {Number} page.total 分页总数
  19. * @apiSuccess {Number} page.current_page 当前页
  20. * @apiSuccess {Number} page.total_page 总页数
  21. * @apiSuccess {Number} page.next_page 下一页
  22. * @apiSuccess {Number} page.prev_page 上一页
  23. * @apiSuccess {Number} page.status 是否有下一页数据,0为没有
  24. */
  25. /**
  26. * @api {get} common.type 类型设置说明
  27. * @apiVersion 1.0.0
  28. * @apiName common.type
  29. * @apiGroup Common
  30. *
  31. * @apiDescription 类型设置说明
  32. *
  33. * @apiParam {String} source_type 请在header中定义,ios:ios | android:android | 移动h5:h5 | 小程序:applet | 公众号:service | pc网站:pc
  34. * @apiParam {Number} type 图文:1 | 视频:2 | 直播:3 | 小刊:4 | 音频:5 | 链接:10 | 评论: 11
  35. * @apiParam {Number} push_ 所有带push_开头的返回参数,返回字典都是一样的,参考获取首页数据中的push_focus
  36. */
  37. /**
  38. * @api {get} wonderful/passport/?l=applet.bind 用户登录
  39. * @apiVersion 1.0.0
  40. * @apiName applet.bind
  41. * @apiGroup AppletPassport
  42. *
  43. * @apiDescription 用户登录
  44. *
  45. * @apiParam {String} code 微信登录返回的code
  46. *
  47. * @apiSuccess {Number} vid 微信id,请保存在本地
  48. * @apiSuccess {Number} uid 用户id,请保存在本地
  49. * @apiSuccess {String} signature 用于登录后的uid验证,每次都要传入,请登录后将这个值保存在本地
  50. */
  51. /**
  52. * @api {get} wonderful/passport/?l=applet.update 更新用户信息
  53. * @apiVersion 1.0.0
  54. * @apiName applet.update
  55. * @apiGroup AppletPassport
  56. *
  57. * @apiDescription 更新用户信息
  58. *
  59. * @apiParam {String} nickname 用户昵称
  60. * @apiParam {String} avatarurl 用户头像
  61. * @apiParam {String} gender 性别
  62. * @apiParam {String} city 城市
  63. * @apiParam {String} province 省份
  64. * @apiParam {String} country 县区
  65. * @apiParam {String} iv 微信的加密参数
  66. * @apiParam {String} encryptedData 微信的加密参数
  67. * @apiParam {Number} vid 微信id
  68. * @apiParam {Number} uid 用户id
  69. * @apiParam {String} signature signature
  70. *
  71. *
  72. * @apiSuccess {Number} vid 微信id,请保存在本地
  73. * @apiSuccess {Number} uid 用户id,请保存在本地
  74. * @apiSuccess {String} signature 用于登录后的uid验证,每次都要传入,请登录后将这个值保存在本地
  75. */
  76. /**
  77. * @api {get} wonderful/passport/?l=applet.mobile 更新用户手机号-微信绑定
  78. * @apiVersion 1.0.0
  79. * @apiName applet.mobile
  80. * @apiGroup AppletPassport
  81. *
  82. * @apiDescription 更新用户手机号-微信绑定
  83. *
  84. * @apiParam {String} iv 微信的加密参数
  85. * @apiParam {String} encryptedData 微信的加密参数
  86. * @apiParam {Number} vid 微信id
  87. * @apiParam {Number} uid 用户id
  88. * @apiParam {String} signature signature
  89. *
  90. *
  91. * @apiSuccess {Number} vid 微信id,请保存在本地
  92. * @apiSuccess {Number} uid 用户id,请保存在本地
  93. * @apiSuccess {String} signature 用于登录后的uid验证,每次都要传入,请登录后将这个值保存在本地
  94. */
  95. /**
  96. * @api {get} wonderful/passport/?l=applet.bind_mobile 更新用户手机号-验证码绑定
  97. * @apiVersion 1.0.0
  98. * @apiName applet.bind_mobile
  99. * @apiGroup AppletPassport
  100. *
  101. * @apiDescription 更新用户手机号-验证码绑定
  102. *
  103. * @apiParam {Number} uid 用户id
  104. * @apiParam {Number} mobile 手机号
  105. * @apiParam {String} mcode 验证码
  106. * @apiParam {String} signature signature
  107. *
  108. * @apiSuccess {Number} uid 用户id,请保存在本地
  109. * @apiSuccess {String} signature 用于登录后的uid验证,每次都要传入,请登录后将这个值保存在本地
  110. */
  111. /**
  112. * @api {get} wonderful/passport/?l=reg.getMCode 获取手机验证码
  113. * @apiVersion 1.0.0
  114. * @apiName reg.getMCode
  115. * @apiGroup AppletPassport
  116. *
  117. * @apiDescription 获取手机验证码
  118. *
  119. * @apiParam {Number} mobile 手机号
  120. *
  121. * @apiSuccess {String} msg 验证码已发送至您的手机,请注意查收,十分钟之内有效
  122. */
  123. /**
  124. * @api {get} wonderful/passport/?l=reg.getMCode 获取手机验证码,未登录状态
  125. * @apiVersion 1.0.0
  126. * @apiName reg.getMCode
  127. * @apiGroup AppPassport
  128. *
  129. * @apiDescription 获取手机验证码,未登录状态
  130. *
  131. * @apiParam {Number} mobile 手机号
  132. *
  133. * @apiSuccess {String} msg 验证码已发送至您的手机,请注意查收,十分钟之内有效
  134. */
  135. /**
  136. * @api {get} wonderful/passport/?l=reg.getMCodeLogin 获取手机验证码,已登录状态
  137. * @apiVersion 1.0.0
  138. * @apiName reg.getMCode
  139. * @apiGroup AppPassport
  140. *
  141. * @apiDescription 获取手机验证码,已登录状态
  142. *
  143. * @apiParam {Number} mobile 手机号
  144. * @apiParam {String} signature signature
  145. *
  146. * @apiSuccess {String} msg 验证码已发送至您的手机,请注意查收,十分钟之内有效
  147. */
  148. /**
  149. * @api {get} wonderful/passport/?l=app.login 登录与注册
  150. * @apiVersion 1.0.0
  151. * @apiName app.login
  152. * @apiGroup AppPassport
  153. *
  154. * @apiDescription 登录与注册
  155. *
  156. * @apiParam {Number} mobile 手机号
  157. * @apiParam {String} code 验证码
  158. *
  159. * @apiSuccess {Number} uid 用户id,请保存在本地
  160. * @apiSuccess {String} signature 用于登录后的uid验证,每次都要传入,请登录后将这个值保存在本地
  161. */
  162. /**
  163. * @api {get} wonderful/passport/?l=app.update 更新用户信息
  164. * @apiVersion 1.0.0
  165. * @apiName app.update
  166. * @apiGroup AppPassport
  167. *
  168. * @apiDescription 更新用户信息
  169. *
  170. * @apiParam {Number} signature 用户signature
  171. * @apiParam {String} avatar 头像
  172. * @apiParam {String} gender 性别
  173. * @apiParam {String} city 城市
  174. * @apiParam {String} province 省份
  175. * @apiParam {String} country 县区
  176. *
  177. * @apiSuccess {Number} uid 用户id,请保存在本地
  178. * @apiSuccess {String} signature 用于登录后的uid验证,每次都要传入,请登录后将这个值保存在本地
  179. */
  180. /**
  181. * @api {get} wonderful/live/?l=api.get 获取直播推流信息
  182. * @apiVersion 1.0.0
  183. * @apiName api.get
  184. * @apiGroup Live
  185. *
  186. * @apiDescription 获取直播推流信息
  187. *
  188. * @apiParam {String} signature 请将字符串signature_dever_2018_jm经过md5加密
  189. *
  190. * @apiSuccess {Object[]} active 直播活动列表
  191. * @apiSuccess {String} active.id 活动id
  192. * @apiSuccess {String} acitve.name 活动名称
  193. * @apiSuccess {Object[]} active.stream 直播流列表
  194. * @apiSuccess {String} active.stream.id 推流id
  195. * @apiSuccess {String} active.stream.live 推流实际地址
  196. * @apiSuccess {String} active.stream.url_rtmp 播放地址
  197. * @apiSuccess {String} active.stream.url_hls 播放地址
  198. * @apiSuccess {String} active.stream.url_hdl 播放地址
  199. * @apiSuccess {String} active.stream.url_pic 实时截图地址
  200. */
  201. /**
  202. * @api {get} wonderful/live/?l=api.start 开始推流
  203. * @apiVersion 1.0.0
  204. * @apiName api.start
  205. * @apiGroup Live
  206. *
  207. * @apiDescription 开始推流
  208. *
  209. * @apiParam {String} signature 请将字符串signature_dever_2018_jm经过md5加密
  210. * @apiParam {Number} id 推流id
  211. *
  212. * @apiSuccess {Number} id 推流id
  213. * @apiSuccess {Number} log_id 本次推流日志id
  214. */
  215. /**
  216. * @api {get} wonderful/live/?l=api.stop 结束推流
  217. * @apiVersion 1.0.0
  218. * @apiName api.stop
  219. * @apiGroup Live
  220. *
  221. * @apiDescription 结束推流 一定要调用该接口,否则不会生成回放地址
  222. *
  223. * @apiParam {String} signature 请将字符串signature_dever_2018_jm经过md5加密
  224. * @apiParam {Number} id 推流id
  225. * @apiParam {Number} log_id 本次推流日志id
  226. */
  227. /**
  228. * @api {get} wonderful/main/?l=content.home 获取首页数据
  229. * @apiVersion 1.0.0
  230. * @apiName content.home
  231. * @apiGroup Content
  232. *
  233. * @apiDescription 获取首页数据
  234. *
  235. * @apiParam {String} signature signature
  236. *
  237. *
  238. * @apiSuccess {Number} uid 用户id 所有接口中都有该项
  239. * @apiSuccess {Object[]} config 基本配置 所有接口中都有该项
  240. * @apiSuccess {String} config.name 系统名称 请将小程序和app头部名称替换为该字段
  241. * @apiSuccess {String} config.info 系统介绍
  242. * @apiSuccess {String} config.logo 系统logo
  243. * @apiSuccess {Object[]} menu 栏目
  244. * @apiSuccess {String} menu.name 名称
  245. * @apiSuccess {String} menu.id 栏目id,访问content.news时可以使用menu=menu.id
  246. * @apiSuccess {Object[]} push_focus 焦点图
  247. * @apiSuccess {String} push_focus.name 名称
  248. * @apiSuccess {String} push_focus.pic 图片
  249. * @apiSuccess {String} push_focus.type 类型,参考公共参数中的类型设置说明中的type说明
  250. * @apiSuccess {String} push_focus.id 源表id,根据type计算路径,然后把这个id加上就是最终的path,小程序和app同样。如果没有id,则进入type相对应的列表。请做好判断!!
  251. * @apiSuccess {String} push_focus.link 当type==10时有效,链接
  252. * @apiSuccess {String} push_focus.cdate 时间
  253. * @apiSuccess {Object[]} push_link 精选分类,字段同上
  254. * @apiSuccess {Object[]} push_ad 广告位,字段同上
  255. * @apiSuccess {Object[]} push_open_ad 弹窗广告位,字段同上
  256. * @apiSuccess {Object[]} push_up 精选推荐,字段同上
  257. * @apiSuccess {Object[]} news 更多图文等数据
  258. * @apiSuccess {String} news.id 图文id
  259. * @apiSuccess {String} news.name 名称
  260. * @apiSuccess {String} news.pic_cover 图片
  261. * @apiSuccess {String} news.type 类型,参考公共参数中的类型设置说明中的type说明,根据它生成path
  262. * @apiSuccess {String} news.pdate 时间
  263. * @apiSuccess {String} news.num_view 浏览量
  264. * @apiSuccess {String} news.num_up 喜欢量
  265. * @apiSuccess {String} news.num_comment 评论量
  266. * @apiSuccess {String} news.num_ding 订阅量
  267. * @apiSuccess {String} news.num_user 在线人数
  268. * @apiSuccess {String} news.share_yes 是否显示分享按钮 1显示 2不显示
  269. * @apiSuccess {String} news.share_title 分享标题
  270. * @apiSuccess {String} news.share_pic 分享图片
  271. * @apiSuccess {String} news.share_content 分享内容
  272. */
  273. /**
  274. * @api {get} wonderful/main/?l=content.up 精选推荐更多
  275. * @apiVersion 1.0.0
  276. * @apiName content.up
  277. * @apiGroup Content
  278. *
  279. * @apiDescription 精选推荐更多
  280. *
  281. * @apiParam {String} signature signature
  282. *
  283. *
  284. * @apiSuccess {Object[]} push_up 栏目,字段同上
  285. * @apiSuccess {String} push_up.name 名称
  286. * @apiSuccess {String} push_up.pic 图片
  287. * @apiSuccess {String} push_up.type 类型,参考公共参数中的类型设置说明中的type说明
  288. * @apiSuccess {String} push_up.id 源表id,根据type计算路径,然后把这个source_id加上就是最终的path,小程序和app同样。
  289. * @apiSuccess {String} push_up.link 当type==10时有效,链接
  290. * @apiSuccess {String} push_up.cdate 时间
  291. */
  292. /**
  293. * @api {get} wonderful/main/?l=content.news 精选页图文内容下拉更多
  294. * @apiVersion 1.0.0
  295. * @apiName content.news
  296. * @apiGroup Content
  297. *
  298. * @apiDescription 精选页图文内容下拉更多
  299. *
  300. * @apiParam {String} signature signature
  301. * @apiParam {Number} menu 可选参数,栏目id
  302. * @apiParam {Number} type 可选参数,类型1为图文、2为视频、3为直播,小刊请到专门的接口获取
  303. *
  304. * @apiSuccess {Object[]} news 更多图文等数据
  305. * @apiSuccess {String} news.id 图文id
  306. * @apiSuccess {String} news.name 名称
  307. * @apiSuccess {String} news.pic_cover 图片
  308. * @apiSuccess {String} news.type 类型,参考公共参数中的类型设置说明中的type说明,根据它生成path
  309. * @apiSuccess {String} news.pdate 时间
  310. * @apiSuccess {String} news.num_view 浏览量
  311. * @apiSuccess {String} news.num_up 喜欢量
  312. * @apiSuccess {String} news.num_comment 评论量
  313. * @apiSuccess {String} news.num_ding 订阅量
  314. * @apiSuccess {String} news.num_user 在线人数
  315. * @apiSuccess {String} news.share_yes 是否显示分享按钮 1显示 2不显示
  316. * @apiSuccess {String} news.share_title 分享标题
  317. * @apiSuccess {String} news.share_pic 分享图片
  318. * @apiSuccess {String} news.share_content 分享内容
  319. */
  320. /**
  321. * @api {get} wonderful/main/?l=view.comment 查看评论列表
  322. * @apiVersion 1.0.0
  323. * @apiName view.comment
  324. * @apiGroup Content
  325. *
  326. * @apiDescription 查看评论列表
  327. *
  328. * @apiParam {String} signature signature
  329. * @apiParam {Number} id 图文id
  330. * @apiParam {Number} type 类型,参考公共参数中的类型设置说明中的type说明
  331. *
  332. * @apiSuccess {Object[]} comment 评论列表
  333. * @apiSuccess {String} comment.id
  334. * @apiSuccess {String} comment.username 用户名
  335. * @apiSuccess {String} comment.avatar 头像
  336. * @apiSuccess {String} comment.content 内容
  337. * @apiSuccess {String} comment.num_up 点赞数
  338. * @apiSuccess {String} comment.cdate 时间
  339. * @apiSuccess {String} comment.up 是否点赞 1为点赞 2为未点赞
  340. */
  341. /**
  342. * @api {get} wonderful/main/?l=view.article 查看图文内容
  343. * @apiVersion 1.0.0
  344. * @apiName view.article
  345. * @apiGroup Content
  346. *
  347. * @apiDescription 查看图文内容
  348. *
  349. * @apiParam {String} signature signature
  350. * @apiParam {Number} id 图文id
  351. *
  352. * @apiSuccess {Object[]} info 图文数据
  353. * @apiSuccess {String} info.id
  354. * @apiSuccess {String} info.name 名称
  355. * @apiSuccess {String} info.pic_cover 图片
  356. * @apiSuccess {String} info.type 类型,参考公共参数中的类型设置说明中的type说明,根据它生成path
  357. * @apiSuccess {String} info.pdate 时间
  358. * @apiSuccess {String} info.cate_id 栏目ID
  359. * @apiSuccess {String} info.cate_name 栏目名称
  360. * @apiSuccess {String} info.author_id 作者ID
  361. * @apiSuccess {String} info.author_name 作者名称
  362. * @apiSuccess {String} info.num_view 浏览量
  363. * @apiSuccess {String} info.num_up 喜欢量
  364. * @apiSuccess {String} info.num_comment 评论量
  365. * @apiSuccess {String} info.share_yes 是否显示分享按钮 1显示 2不显示
  366. * @apiSuccess {String} info.share_title 分享标题
  367. * @apiSuccess {String} info.share_pic 分享图片
  368. * @apiSuccess {String} info.share_content 分享内容
  369. * @apiSuccess {String} info.function 开启的功能,这是一个字符串,用逗号隔开的,1代表显示浏览量,2代表显示评论,3代表显示喜欢,如值为1,2,则显示浏览量、评论,不显示喜欢
  370. * @apiSuccess {String} info.content 内容
  371. * @apiSuccess {String} info.content_array 数组内容,请使用该字段循环,type为类型,请参考类型设置说明,content为内容,type为1时为图文内容,type为2时content为视频详情的字段,type为3时content为直播详情的字段,type为5时content为音频地址
  372. *
  373. * @apiSuccess {Object[]} comment 评论列表
  374. * @apiSuccess {String} comment.id
  375. * @apiSuccess {String} comment.username 用户名
  376. * @apiSuccess {String} comment.avatar 头像
  377. * @apiSuccess {String} comment.content 内容
  378. * @apiSuccess {String} comment.num_up 点赞数
  379. * @apiSuccess {String} comment.cdate 时间
  380. * @apiSuccess {String} comment.up 是否点赞 1为点赞 2为未点赞
  381. *
  382. * @apiSuccess {Object[]} user_act 用户行为 当用户登录时有效
  383. * @apiSuccess {String} user_act.share 用户分享数
  384. * @apiSuccess {String} user_act.up 是否喜欢1为喜欢,2为未喜欢
  385. */
  386. /**
  387. * @api {get} wonderful/main/?l=view.vod 查看视频内容
  388. * @apiVersion 1.0.0
  389. * @apiName view.vod
  390. * @apiGroup Content
  391. *
  392. * @apiDescription 查看视频内容
  393. *
  394. * @apiParam {String} signature signature
  395. * @apiParam {Number} id 视频id
  396. *
  397. * @apiSuccess {Object[]} info 视频数据
  398. * @apiSuccess {String} info.id
  399. * @apiSuccess {String} info.name 名称
  400. * @apiSuccess {String} info.pic_cover 图片
  401. * @apiSuccess {String} info.type 类型,参考公共参数中的类型设置说明中的type说明,根据它生成path
  402. * @apiSuccess {String} info.pdate 时间
  403. * @apiSuccess {String} info.cate_id 栏目ID
  404. * @apiSuccess {String} info.cate_name 栏目名称
  405. * @apiSuccess {String} info.author_id 作者ID
  406. * @apiSuccess {String} info.author_name 作者名称
  407. * @apiSuccess {String} info.num_view 浏览量
  408. * @apiSuccess {String} info.num_up 喜欢量
  409. * @apiSuccess {String} info.num_comment 评论量
  410. * @apiSuccess {String} info.share_yes 是否显示分享按钮 1显示 2不显示
  411. * @apiSuccess {String} info.share_title 分享标题
  412. * @apiSuccess {String} info.share_pic 分享图片
  413. * @apiSuccess {String} info.share_content 分享内容
  414. * @apiSuccess {String} info.function 开启的功能,这是一个字符串,用逗号隔开的,1代表显示浏览量,2代表显示评论,3代表显示喜欢,4代表显示邀请阅读,如值为1,2,3,则显示浏览量、评论、喜欢,不显示邀请阅读
  415. * @apiSuccess {String} info.content 内容
  416. *
  417. *
  418. * @apiSuccess {Object[]} comment 评论列表
  419. * @apiSuccess {String} comment.id
  420. * @apiSuccess {String} comment.username 用户名
  421. * @apiSuccess {String} comment.avatar 头像
  422. * @apiSuccess {String} comment.content 内容
  423. * @apiSuccess {String} comment.num_up 点赞数
  424. * @apiSuccess {String} comment.cdate 时间
  425. * @apiSuccess {String} comment.up 是否点赞 1为点赞 2为未点赞
  426. *
  427. * @apiSuccess {Object[]} user_act 用户行为 当用户登录时有效
  428. * @apiSuccess {String} user_act.share 用户分享数
  429. * @apiSuccess {String} user_act.up 是否喜欢1为喜欢,2为未喜欢
  430. */
  431. /**
  432. * @api {get} wonderful/main/?l=view.live 查看直播内容
  433. * @apiVersion 1.0.0
  434. * @apiName view.live
  435. * @apiGroup Content
  436. *
  437. * @apiDescription 查看直播内容
  438. *
  439. * @apiParam {String} signature signature
  440. * @apiParam {Number} id 视频id
  441. *
  442. * @apiSuccess {Object[]} info 直播数据
  443. * @apiSuccess {String} info.id
  444. * @apiSuccess {String} info.name 名称
  445. * @apiSuccess {String} info.pic_cover 封面图片
  446. * @apiSuccess {String} info.type 类型,参考公共参数中的类型设置说明中的type说明,根据它生成path
  447. * @apiSuccess {String} info.pdate 时间
  448. * @apiSuccess {String} info.cate_id 栏目ID
  449. * @apiSuccess {String} info.cate_name 栏目名称
  450. * @apiSuccess {String} info.author_id 作者ID
  451. * @apiSuccess {String} info.author_name 作者名称
  452. * @apiSuccess {String} info.sdate_time 开始时间
  453. * @apiSuccess {String} info.edate_time 结束时间
  454. * @apiSuccess {String} info.num_user 在线人数
  455. * @apiSuccess {String} info.num_view 浏览量
  456. * @apiSuccess {String} info.num_up 喜欢量
  457. * @apiSuccess {String} info.num_comment 评论量
  458. * @apiSuccess {String} info.share_yes 是否显示分享按钮 1显示 2不显示
  459. * @apiSuccess {String} info.share_title 分享标题
  460. * @apiSuccess {String} info.share_pic 分享图片
  461. * @apiSuccess {String} info.share_content 分享内容
  462. * @apiSuccess {String} info.function 开启的功能,这是一个字符串,用逗号隔开的,1代表显示浏览量,2代表显示评论,3代表显示喜欢,4代表显示邀请阅读,如值为1,2,3,则显示浏览量、评论、喜欢,不显示邀请阅读
  463. * @apiSuccess {String} info.content 直播介绍
  464. * @apiSuccess {String} info.stream 直播推流地址
  465. * @apiSuccess {String} info.stream_rtmp 直播高清播放地址
  466. * @apiSuccess {String} info.stream_hls 直播标清播放地址
  467. * @apiSuccess {String} info.stream_hdl 直播普清播放地址
  468. * @apiSuccess {String} info.stream_pic 直播截图地址,直播中时,可以用来替代pic_cover
  469. * @apiSuccess {String} info.url_mp4 回放播放地址
  470. * @apiSuccess {String} info.status 直播状态1为未开始2为直播中3为已结束
  471. *
  472. *
  473. * @apiSuccess {Object[]} comment 评论列表
  474. * @apiSuccess {String} comment.id
  475. * @apiSuccess {String} comment.username 用户名
  476. * @apiSuccess {String} comment.avatar 头像
  477. * @apiSuccess {String} comment.content 内容
  478. * @apiSuccess {String} comment.num_up 点赞数
  479. * @apiSuccess {String} comment.cdate 时间
  480. * @apiSuccess {String} comment.up 是否点赞 1为点赞 2为未点赞
  481. *
  482. * @apiSuccess {Object[]} user_act 用户行为 当用户登录时有效
  483. * @apiSuccess {String} user_act.share 用户分享数
  484. * @apiSuccess {String} user_act.up 是否喜欢1为喜欢,2为未喜欢
  485. * @apiSuccess {String} user_act.note 是否预约提醒1为已预约,2为未预约
  486. */
  487. /**
  488. * @api {get} wonderful/main/?l=user.submit_up 喜欢
  489. * @apiVersion 1.0.0
  490. * @apiName user.submit_up
  491. * @apiGroup UserAction
  492. *
  493. * @apiDescription 喜欢
  494. *
  495. * @apiParam {String} signature signature
  496. * @apiParam {Number} type type类型 这里增加了一个评论点赞(喜欢),type的值为11就是 给评论点赞
  497. * @apiParam {Number} id 当前的数据id
  498. *
  499. * @apiSuccess {Number} id 当前的数据id
  500. */
  501. /**
  502. * @api {get} wonderful/main/?l=user.submit_note 直播预约提醒
  503. * @apiVersion 1.0.0
  504. * @apiName user.submit_note
  505. * @apiGroup UserAction
  506. *
  507. * @apiDescription 直播预约提醒
  508. *
  509. * @apiParam {String} signature signature
  510. * @apiParam {Number} type type类型
  511. * @apiParam {Number} id 当前的数据id
  512. *
  513. * @apiSuccess {Number} id 当前的数据id
  514. */
  515. /**
  516. * @api {get} wonderful/main/?l=user.submit_share 分享
  517. * @apiVersion 1.0.0
  518. * @apiName user.submit_share
  519. * @apiGroup UserAction
  520. *
  521. * @apiDescription 分享
  522. *
  523. * @apiParam {String} signature signature
  524. * @apiParam {Number} type type类型
  525. * @apiParam {Number} id 当前的数据id
  526. * @apiParam {String} desc 说明:这是分享的说明介绍,请不要传入该参数,底层页分享时,请把路径path设置为首页的path?scene=signature,type,id signature:当前邀请者的signature | type:当前分享的类型 图文等 | id:当前分享的图文的id,小程序中请判断,如果首页有scene参数,请在正常请求首页数据之后,先发起分享回流接口的请求,然后根据scene参数中的type和id的值,跳转到type所对应的path的详情页即可。
  527. *
  528. * @apiSuccess {Number} id 当前的数据id
  529. */
  530. /**
  531. * @api {get} wonderful/main/?l=user.submit_share_reflux 分享回流
  532. * @apiVersion 1.0.0
  533. * @apiName user.submit_share_reflux
  534. * @apiGroup UserAction
  535. *
  536. * @apiDescription 分享回流
  537. *
  538. * @apiParam {String} signature signature
  539. * @apiParam {Number} type type类型 scene参数中的第二个值
  540. * @apiParam {Number} id 当前的数据id scene参数中的第三个值
  541. * @apiParam {String} source_signature 回流的源用户id,scene参数中的第一个值
  542. *
  543. * @apiSuccess {Number} id 当前的数据id
  544. */
  545. /**
  546. * @api {get} wonderful/main/?l=user.submit_comment 提交评论
  547. * @apiVersion 1.0.0
  548. * @apiName user.submit_comment
  549. * @apiGroup UserAction
  550. *
  551. * @apiDescription 提交评论
  552. *
  553. * @apiParam {String} signature signature
  554. * @apiParam {Number} type type类型
  555. * @apiParam {Number} id 当前的数据id
  556. * @apiParam {String} content 评论内容
  557. *
  558. * @apiSuccess {Number} id 当前的数据id
  559. */
  560. /**
  561. * @api {get} wonderful/main/?l=journal.home 小刊首页
  562. * @apiVersion 1.0.0
  563. * @apiName journal.home
  564. * @apiGroup Journal
  565. *
  566. * @apiDescription 小刊首页
  567. *
  568. * @apiParam {String} signature signature
  569. *
  570. * @apiSuccess {Object[]} journal 小刊数据列表,每页显示10条,请在翻到第7或者第8条时,请求第2页
  571. * @apiSuccess {String} journal.id 小刊id
  572. * @apiSuccess {String} journal.name 名称
  573. * @apiSuccess {String} journal.subname 期号
  574. * @apiSuccess {String} journal.pic_cover 列表封面图片 暂时无效
  575. * @apiSuccess {String} journal.pic_view_cover 小刊封面图片 封面图都用这个
  576. * @apiSuccess {String} journal.pic_view_bg 全屏背景图-进入小刊阅读页之前的全屏背景图,可以多张切换,多个用逗号隔开,请用逗号截取成数组
  577. * @apiSuccess {String} journal.pdate 时间
  578. * @apiSuccess {String} journal.num_ding 订阅数
  579. * @apiSuccess {String} journal.num_view 浏览量
  580. * @apiSuccess {String} journal.num_comment 评论量
  581. * @apiSuccess {String} journal.buy 小刊是否收费 1收费 2不收费
  582. *
  583. * @apiSuccess {Object[]} subscribe 订阅列表
  584. * @apiSuccess {String} subscribe.id
  585. * @apiSuccess {String} subscribe.username 用户名
  586. * @apiSuccess {String} subscribe.avatar 头像
  587. * @apiSuccess {Object[]} push_jingxuan 精选推荐
  588. * @apiSuccess {String} push_jingxuan.name 名称
  589. * @apiSuccess {String} push_jingxuan.pic 图片
  590. * @apiSuccess {String} push_jingxuan.type 类型,这里为4
  591. * @apiSuccess {String} push_jingxuan.id 源表id,这里是小刊的id
  592. * @apiSuccess {String} push_jingxuan.cdate 时间
  593. * @apiSuccess {Number} push_jingxuan_more 是否显示更多按钮1显示2不显示
  594. */
  595. /**
  596. * @api {get} wonderful/main/?l=user.my 获取用户信息
  597. * @apiVersion 1.0.0
  598. * @apiName user.my
  599. * @apiGroup User
  600. *
  601. * @apiDescription 获取用户信息
  602. *
  603. * @apiParam {String} signature signature
  604. *
  605. * @apiSuccess {Object[]} user 用户基本信息
  606. * @apiSuccess {String} user.id 用户id
  607. * @apiSuccess {String} user.username 用户名
  608. * @apiSuccess {String} user.mobile 手机号
  609. * @apiSuccess {String} user.avatar 头像
  610. * @apiSuccess {String} user.level 等级
  611. * @apiSuccess {String} user.score 积分
  612. * @apiSuccess {Number} user_msg 用户新消息数
  613. */
  614. /**
  615. * @api {get} wonderful/main/?l=user.my_msg 获取我的消息
  616. * @apiVersion 1.0.0
  617. * @apiName user.my_msg
  618. * @apiGroup User
  619. *
  620. * @apiDescription 获取我的消息
  621. *
  622. * @apiParam {String} signature signature
  623. *
  624. * @apiSuccess {Object[]} msg 消息列表
  625. * @apiSuccess {String} msg.uid 用户id
  626. * @apiSuccess {String} msg.from_uid 消息来源uid,暂时不用管
  627. * @apiSuccess {String} msg.name 消息标题
  628. * @apiSuccess {String} msg.content 消息内容
  629. * @apiSuccess {String} msg.cdate 时间戳
  630. * @apiSuccess {String} msg.cdate_time 转换成了Y-m-d H:i:s的时间
  631. * @apiSuccess {String} msg.status 消息已读状态1未读2已读
  632. * @apiSuccess {String} msg.type 消息类型,暂时不用管
  633. */
  634. /**
  635. * @api {get} wonderful/main/?l=user.my_up 获取我喜欢的信息
  636. * @apiVersion 1.0.0
  637. * @apiName user.my_up
  638. * @apiGroup User
  639. *
  640. * @apiDescription 获取我喜欢的信息
  641. *
  642. * @apiParam {String} signature signature
  643. *
  644. * @apiSuccess {Object[]} like 用户基本信息
  645. * @apiSuccess {String} like.uid 用户id
  646. * @apiSuccess {String} like.data_id 数据id
  647. * @apiSuccess {String} like.cdate 时间戳
  648. * @apiSuccess {String} like.cdate_time 转换成了Y-m-d H:i:s的时间
  649. * @apiSuccess {String} like.type 类型,参考公共参数中的类型设置说明中的type说明
  650. * @apiSuccess {Object[]} like.info 基本信息 根据type不同,里面的字段有所不同
  651. * @apiSuccess {String} like.info.id 数据id
  652. * @apiSuccess {String} like.info.name 名称
  653. * @apiSuccess {String} like.info.cate_id 栏目ID
  654. * @apiSuccess {String} like.info.cate_name 栏目名称
  655. * @apiSuccess {String} like.info.pic_cover 图片
  656. * @apiSuccess {String} like.info.pdate 发布时间
  657. */
  658. /**
  659. * @api {get} wonderful/main/?l=user.my_comment 获取我评论的信息
  660. * @apiVersion 1.0.0
  661. * @apiName user.my_comment
  662. * @apiGroup User
  663. *
  664. * @apiDescription 获取我喜欢的信息
  665. *
  666. * @apiParam {String} signature signature
  667. *
  668. * @apiSuccess {Object[]} comment 用户基本信息
  669. * @apiSuccess {String} comment.uid 用户id
  670. * @apiSuccess {String} comment.data_id 数据id
  671. * @apiSuccess {String} comment.content 评论内容
  672. * @apiSuccess {String} comment.time 时间:x小时前
  673. * @apiSuccess {String} comment.cdate 时间戳
  674. * @apiSuccess {String} comment.cdate_time 转换成了Y-m-d H:i:s的时间
  675. * @apiSuccess {String} comment.type 类型,参考公共参数中的类型设置说明中的type说明
  676. * @apiSuccess {Object[]} comment.info 基本信息 根据type不同,里面的字段有所不同
  677. * @apiSuccess {String} comment.info.id 数据id
  678. * @apiSuccess {String} comment.info.name 名称
  679. * @apiSuccess {String} comment.info.cate_id 栏目ID
  680. * @apiSuccess {String} comment.info.cate_name 栏目名称
  681. * @apiSuccess {String} comment.info.pic_cover 图片
  682. * @apiSuccess {String} comment.info.pdate 发布时间
  683. */