apidoc.php 48 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174
  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 | 专题:6 | 小程序:7 | 商品:8 | 链接:10 | 评论: 11 || 直播评论:12 | 小刊活动页:13
  35. * @apiParam {Number} push_ 所有带push_开头的返回参数,返回字典都是一样的,参考获取首页数据中的push_focus
  36. */
  37. /**
  38. * @api {post} upload/upload/?save.start 上传图片接口
  39. * @apiVersion 1.0.0
  40. * @apiName save.start
  41. * @apiGroup Common
  42. *
  43. * @apiParam {Number} key 值为6,写死即可
  44. * @apiParam {String} file 文件流 multipart/form-data形式
  45. *
  46. * @apiSuccess {String} url 图片地址
  47. */
  48. /**
  49. * @api {get} wonderful/passport/?l=applet.bind 用户登录
  50. * @apiVersion 1.0.0
  51. * @apiName applet.bind
  52. * @apiGroup AppletPassport
  53. *
  54. * @apiDescription 用户登录
  55. *
  56. * @apiParam {String} code 微信登录返回的code
  57. *
  58. * @apiSuccess {Number} vid 微信id,请保存在本地
  59. * @apiSuccess {Number} uid 用户id,请保存在本地
  60. * @apiSuccess {String} signature 用于登录后的uid验证,每次都要传入,请登录后将这个值保存在本地
  61. */
  62. /**
  63. * @api {get} wonderful/passport/?l=applet.update 更新用户信息
  64. * @apiVersion 1.0.0
  65. * @apiName applet.update
  66. * @apiGroup AppletPassport
  67. *
  68. * @apiDescription 更新用户信息
  69. *
  70. * @apiParam {String} nickname 用户昵称
  71. * @apiParam {String} avatarurl 用户头像
  72. * @apiParam {String} gender 性别
  73. * @apiParam {String} city 城市
  74. * @apiParam {String} province 省份
  75. * @apiParam {String} country 县区
  76. * @apiParam {String} iv 微信的加密参数
  77. * @apiParam {String} encryptedData 微信的加密参数
  78. * @apiParam {Number} vid 微信id
  79. * @apiParam {Number} uid 用户id
  80. * @apiParam {String} signature signature
  81. *
  82. *
  83. * @apiSuccess {Number} vid 微信id,请保存在本地
  84. * @apiSuccess {Number} uid 用户id,请保存在本地
  85. * @apiSuccess {String} signature 用于登录后的uid验证,每次都要传入,请登录后将这个值保存在本地
  86. */
  87. /**
  88. * @api {get} wonderful/passport/?l=applet.mobile 更新用户手机号-微信绑定
  89. * @apiVersion 1.0.0
  90. * @apiName applet.mobile
  91. * @apiGroup AppletPassport
  92. *
  93. * @apiDescription 更新用户手机号-微信绑定
  94. *
  95. * @apiParam {String} iv 微信的加密参数
  96. * @apiParam {String} encryptedData 微信的加密参数
  97. * @apiParam {Number} vid 微信id
  98. * @apiParam {Number} uid 用户id
  99. * @apiParam {String} signature signature
  100. *
  101. *
  102. * @apiSuccess {Number} vid 微信id,请保存在本地
  103. * @apiSuccess {Number} uid 用户id,请保存在本地
  104. * @apiSuccess {String} signature 用于登录后的uid验证,每次都要传入,请登录后将这个值保存在本地
  105. */
  106. /**
  107. * @api {get} wonderful/passport/?l=applet.bind_mobile 更新用户手机号-验证码绑定
  108. * @apiVersion 1.0.0
  109. * @apiName applet.bind_mobile
  110. * @apiGroup AppletPassport
  111. *
  112. * @apiDescription 更新用户手机号-验证码绑定
  113. *
  114. * @apiParam {Number} uid 用户id
  115. * @apiParam {Number} mobile 手机号
  116. * @apiParam {String} mcode 验证码
  117. * @apiParam {String} signature signature
  118. *
  119. * @apiSuccess {Number} uid 用户id,请保存在本地
  120. * @apiSuccess {String} signature 用于登录后的uid验证,每次都要传入,请登录后将这个值保存在本地
  121. */
  122. /**
  123. * @api {get} wonderful/passport/?l=reg.getMCode 获取手机验证码
  124. * @apiVersion 1.0.0
  125. * @apiName reg.getMCode
  126. * @apiGroup AppletPassport
  127. *
  128. * @apiDescription 获取手机验证码
  129. *
  130. * @apiParam {Number} mobile 手机号
  131. *
  132. * @apiSuccess {String} msg 验证码已发送至您的手机,请注意查收,十分钟之内有效
  133. */
  134. /**
  135. * @api {get} wonderful/passport/?l=reg.getMCode 获取手机验证码,未登录状态
  136. * @apiVersion 1.0.0
  137. * @apiName reg.getMCode
  138. * @apiGroup AppPassport
  139. *
  140. * @apiDescription 获取手机验证码,未登录状态
  141. *
  142. * @apiParam {Number} mobile 手机号
  143. *
  144. * @apiSuccess {String} msg 验证码已发送至您的手机,请注意查收,十分钟之内有效
  145. */
  146. /**
  147. * @api {get} wonderful/passport/?l=reg.getMCodeLogin 获取手机验证码,已登录状态
  148. * @apiVersion 1.0.0
  149. * @apiName reg.getMCode
  150. * @apiGroup AppPassport
  151. *
  152. * @apiDescription 获取手机验证码,已登录状态
  153. *
  154. * @apiParam {Number} mobile 手机号
  155. * @apiParam {String} signature signature
  156. *
  157. * @apiSuccess {String} msg 验证码已发送至您的手机,请注意查收,十分钟之内有效
  158. */
  159. /**
  160. * @api {get} wonderful/passport/?l=app.login 登录与注册
  161. * @apiVersion 1.0.0
  162. * @apiName app.login
  163. * @apiGroup AppPassport
  164. *
  165. * @apiDescription 登录与注册
  166. *
  167. * @apiParam {Number} mobile 手机号
  168. * @apiParam {String} code 验证码
  169. *
  170. * @apiSuccess {Number} uid 用户id,请保存在本地
  171. * @apiSuccess {String} signature 用于登录后的uid验证,每次都要传入,请登录后将这个值保存在本地
  172. */
  173. /**
  174. * @api {get} wonderful/passport/?l=app.bind_mobile 更新用户手机号-验证码绑定
  175. * @apiVersion 1.0.0
  176. * @apiName app.bind_mobile
  177. * @apiGroup AppPassport
  178. *
  179. * @apiDescription 更新用户手机号-验证码绑定
  180. *
  181. * @apiParam {Number} uid 用户id
  182. * @apiParam {Number} mobile 手机号
  183. * @apiParam {String} mcode 验证码
  184. * @apiParam {String} signature signature
  185. *
  186. * @apiSuccess {Number} uid 用户id,请保存在本地
  187. * @apiSuccess {String} signature 用于登录后的uid验证,每次都要传入,请登录后将这个值保存在本地
  188. */
  189. /**
  190. * @api {get} wonderful/oauth/?l=request.callback 第三方登录
  191. * @apiVersion 1.0.0
  192. * @apiName request.callback
  193. * @apiGroup AppPassport
  194. *
  195. * @apiDescription 第三方登录
  196. *
  197. * @apiParam {Number} account 第三方登录的账号,写死为2吧
  198. * @apiParam {Number} system 系统id,写死为1,后续做ok精彩和精品时再加
  199. * @apiParam {String} source 渠道来源,写死为1,默认1则为官网渠道
  200. * @apiParam {String} source_type 渠道类型,写死为ios或者android
  201. *
  202. * @apiSuccess {Number} uid 用户id,请保存在本地
  203. * @apiSuccess {Number} mobile 手机号,判断手机号是否存在,不存在则需要进行绑定,请直接使用app.bind_mobile接口进行绑定即可
  204. * @apiSuccess {String} signature 用于登录后的uid验证,每次都要传入,请登录后将这个值保存在本地
  205. */
  206. /**
  207. * @api {get} wonderful/passport/?l=app.update 更新用户信息
  208. * @apiVersion 1.0.0
  209. * @apiName app.update
  210. * @apiGroup AppPassport
  211. *
  212. * @apiDescription 更新用户信息
  213. *
  214. * @apiParam {Number} signature 用户signature
  215. * @apiParam {String} username 用户昵称
  216. * @apiParam {String} avatar 用户头像
  217. * @apiParam {String} gender 性别
  218. * @apiParam {String} city 城市
  219. * @apiParam {String} province 省份
  220. * @apiParam {String} country 县区
  221. *
  222. * @apiSuccess {Number} uid 用户id,请保存在本地
  223. * @apiSuccess {String} signature 用于登录后的uid验证,每次都要传入,请登录后将这个值保存在本地
  224. */
  225. /**
  226. * @api {get} wonderful/main/?l=view.getHtml 获取富文本内容
  227. * @apiVersion 1.0.0
  228. * @apiName view.getHtml
  229. * @apiGroup App
  230. *
  231. * @apiDescription 获取富文本内容
  232. *
  233. * @apiParam {Number} signature 用户signature
  234. * @apiParam {String} type 类型1为图文、2为视频、3为直播、4为小刊内容,6为专题
  235. * @apiParam {String} id 图文等内容id,如果为4,则为小刊的内容id,而非小刊id
  236. *
  237. * @apiSuccess {String} html 直接返回html的信息,请注意里面的协议:jstyle://live_note?id=0&live_id=1&file=test
  238. 其中有几个:
  239. jstyle://video?id=0&vod_id=1&file=test 播放视频 id=0为content_array里的数组索引,vod_id为视频id,file为视频文件地址
  240. jstyle://live?id=0&live_id=1&file=test 播放直播 id=0为content_array里的数组索引,live_id为直播id,file为直播文件地址
  241. jstyle://live_note?id=0&live_id=1&file=test&note=1 设置直播提醒 id=0为content_array里的数组索引,live_id为直播id,file为直播文件地址,note值为1是已设置提醒,2为未设置提醒
  242. jstyle://auido?id=0&file=test&note=1 播放视频 id=0为content_array里的数组索引,file为直播文件地址
  243. */
  244. /**
  245. * @api {get} wonderful/live/?l=api.get 获取直播推流信息
  246. * @apiVersion 1.0.0
  247. * @apiName api.get
  248. * @apiGroup Live
  249. *
  250. * @apiDescription 获取直播推流信息
  251. *
  252. * @apiParam {String} signature 请将字符串signature_dever_2018_jm经过md5加密
  253. *
  254. * @apiSuccess {Object[]} active 直播活动列表
  255. * @apiSuccess {String} active.id 活动id
  256. * @apiSuccess {String} acitve.name 活动名称
  257. * @apiSuccess {Object[]} active.stream 直播流列表
  258. * @apiSuccess {String} active.stream.id 推流id
  259. * @apiSuccess {String} active.stream.live 推流实际地址
  260. * @apiSuccess {String} active.stream.url_rtmp 播放地址
  261. * @apiSuccess {String} active.stream.url_hls 播放地址
  262. * @apiSuccess {String} active.stream.url_hdl 播放地址
  263. * @apiSuccess {String} active.stream.url_pic 实时截图地址
  264. */
  265. /**
  266. * @api {get} wonderful/live/?l=api.start 开始推流
  267. * @apiVersion 1.0.0
  268. * @apiName api.start
  269. * @apiGroup Live
  270. *
  271. * @apiDescription 开始推流
  272. *
  273. * @apiParam {String} signature 请将字符串signature_dever_2018_jm经过md5加密
  274. * @apiParam {Number} id 推流id
  275. *
  276. * @apiSuccess {Number} id 推流id
  277. * @apiSuccess {Number} log_id 本次推流日志id
  278. */
  279. /**
  280. * @api {get} wonderful/live/?l=api.stop 结束推流
  281. * @apiVersion 1.0.0
  282. * @apiName api.stop
  283. * @apiGroup Live
  284. *
  285. * @apiDescription 结束推流 一定要调用该接口,否则不会生成回放地址
  286. *
  287. * @apiParam {String} signature 请将字符串signature_dever_2018_jm经过md5加密
  288. * @apiParam {Number} id 推流id
  289. * @apiParam {Number} log_id 本次推流日志id
  290. */
  291. /**
  292. * @api {get} wonderful/main/?l=content.home 获取首页数据
  293. * @apiVersion 1.0.0
  294. * @apiName content.home
  295. * @apiGroup Content
  296. *
  297. * @apiDescription 获取首页数据
  298. *
  299. * @apiParam {String} signature signature
  300. *
  301. *
  302. * @apiSuccess {Number} uid 用户id 所有接口中都有该项
  303. * @apiSuccess {Object[]} config 基本配置 所有接口中都有该项
  304. * @apiSuccess {String} config.name 系统名称 请将小程序和app头部名称替换为该字段
  305. * @apiSuccess {String} config.info 系统介绍
  306. * @apiSuccess {String} config.logo 系统logo
  307. * @apiSuccess {String} config.article_share_name 图文详情页分享文字
  308. * @apiSuccess {String} config.vod_share_name 视频详情页分享文字
  309. * @apiSuccess {String} config.live_share_name 直播详情页分享文字
  310. * @apiSuccess {String} config.ios_pay ios支付设置 1为不开启小程序支付,将所有购买按钮都隐藏掉,2为开启公众号支付,3开始小程序支付
  311. * @apiSuccess {String} config.ios_pay_pic ios里公众号支付引导图
  312. * @apiSuccess {Object[]} menu 栏目
  313. * @apiSuccess {String} menu.name 名称
  314. * @apiSuccess {String} menu.id 栏目id,访问content.news时可以使用menu=menu.id
  315. * @apiSuccess {Object[]} push_focus 焦点图
  316. * @apiSuccess {String} push_focus.name 名称
  317. * @apiSuccess {String} push_focus.cate_name 栏目名称
  318. * @apiSuccess {String} push_focus.author_name 作者名称
  319. * @apiSuccess {String} push_focus.pic 图片
  320. * @apiSuccess {String} push_focus.type 类型,参考公共参数中的类型设置说明中的type说明
  321. * @apiSuccess {String} push_focus.id 源表id,根据type计算路径,然后把这个id加上就是最终的path,小程序和app同样。如果没有id,则进入type相对应的列表。请做好判断!!
  322. * @apiSuccess {String} push_focus.appid 当type==7时有效,小程序的appid
  323. * @apiSuccess {String} push_focus.link 当type==10时有效,链接
  324. * @apiSuccess {String} push_focus.cdate 时间
  325. * @apiSuccess {Object[]} push_link 精选分类,字段同上
  326. * @apiSuccess {Object[]} push_ad 广告位,字段同上
  327. * @apiSuccess {Object[]} push_open_ad 弹窗广告位,字段同上
  328. * @apiSuccess {Object[]} push_up 精选推荐,字段同上
  329. * @apiSuccess {Object[]} news 更多图文等数据
  330. * @apiSuccess {String} news.id 图文id
  331. * @apiSuccess {String} news.name 名称
  332. * @apiSuccess {String} news.pic_cover 4:3图片
  333. * @apiSuccess {String} news.pic_cover_169 16:9图片
  334. * @apiSuccess {String} news.type 类型,参考公共参数中的类型设置说明中的type说明,根据它生成path
  335. * @apiSuccess {String} news.pdate 时间
  336. * @apiSuccess {String} news.num_view 浏览量
  337. * @apiSuccess {String} news.num_up 喜欢量
  338. * @apiSuccess {String} news.num_comment 评论量
  339. * @apiSuccess {String} news.num_ding 订阅量
  340. * @apiSuccess {String} news.num_user 在线人数
  341. * @apiSuccess {String} news.share_yes 是否显示分享按钮 1显示 2不显示
  342. * @apiSuccess {String} news.share_title 分享标题
  343. * @apiSuccess {String} news.share_pic 分享图片
  344. * @apiSuccess {String} news.share_content 分享内容
  345. */
  346. /**
  347. * @api {get} wonderful/main/?l=content.up 精选推荐更多
  348. * @apiVersion 1.0.0
  349. * @apiName content.up
  350. * @apiGroup Content
  351. *
  352. * @apiDescription 精选推荐更多
  353. *
  354. * @apiParam {String} signature signature
  355. *
  356. *
  357. * @apiSuccess {Object[]} push_up 栏目,字段同上
  358. * @apiSuccess {String} push_up.name 名称
  359. * @apiSuccess {String} push_up.pic 图片
  360. * @apiSuccess {String} push_up.type 类型,参考公共参数中的类型设置说明中的type说明
  361. * @apiSuccess {String} push_up.id 源表id,根据type计算路径,然后把这个source_id加上就是最终的path,小程序和app同样。
  362. * @apiSuccess {String} push_up.link 当type==10时有效,链接
  363. * @apiSuccess {String} push_up.cdate 时间
  364. */
  365. /**
  366. * @api {get} wonderful/main/?l=content.news 精选页图文内容下拉更多
  367. * @apiVersion 1.0.0
  368. * @apiName content.news
  369. * @apiGroup Content
  370. *
  371. * @apiDescription 精选页图文内容下拉更多
  372. *
  373. * @apiParam {String} signature signature
  374. * @apiParam {Number} menu 可选参数,栏目id
  375. * @apiParam {Number} type 可选参数,类型1为图文、2为视频、3为直播,小刊请到专门的接口获取
  376. *
  377. * @apiSuccess {Object[]} news 更多图文等数据
  378. * @apiSuccess {String} news.id 图文id
  379. * @apiSuccess {String} news.name 名称
  380. * @apiSuccess {String} news.pic_cover 4:3图片
  381. * @apiSuccess {String} news.pic_cover_169 16:9图片
  382. * @apiSuccess {String} news.type 类型,参考公共参数中的类型设置说明中的type说明,根据它生成path
  383. * @apiSuccess {String} news.pdate 时间
  384. * @apiSuccess {String} news.num_view 浏览量
  385. * @apiSuccess {String} news.num_up 喜欢量
  386. * @apiSuccess {String} news.num_comment 评论量
  387. * @apiSuccess {String} news.num_ding 订阅量
  388. * @apiSuccess {String} news.num_user 在线人数
  389. * @apiSuccess {String} news.share_yes 是否显示分享按钮 1显示 2不显示
  390. * @apiSuccess {String} news.share_title 分享标题
  391. * @apiSuccess {String} news.share_pic 分享图片
  392. * @apiSuccess {String} news.share_content 分享内容
  393. */
  394. /**
  395. * @api {get} wonderful/main/?l=view.comment 查看评论列表
  396. * @apiVersion 1.0.0
  397. * @apiName view.comment
  398. * @apiGroup Content
  399. *
  400. * @apiDescription 查看评论列表
  401. *
  402. * @apiParam {String} signature signature
  403. * @apiParam {Number} id 图文id
  404. * @apiParam {Number} type 类型,参考公共参数中的类型设置说明中的type说明
  405. *
  406. * @apiSuccess {Object[]} comment 评论列表
  407. * @apiSuccess {String} comment.id
  408. * @apiSuccess {String} comment.username 用户名
  409. * @apiSuccess {String} comment.avatar 头像
  410. * @apiSuccess {String} comment.content 内容
  411. * @apiSuccess {String} comment.num_up 点赞数
  412. * @apiSuccess {String} comment.time 时间,请用这个时间吧
  413. * @apiSuccess {String} comment.cdate 时间
  414. * @apiSuccess {String} comment.up 是否点赞 1为点赞 2为未点赞
  415. * @apiSuccess {String} live_status 当type=3时,有该字段,直播状态,1为直播中,2为已结束,请根据该状态判断当前观看直播的用户是否能观看直播
  416. */
  417. /**
  418. * @api {get} wonderful/main/?l=view.article 查看图文内容
  419. * @apiVersion 1.0.0
  420. * @apiName view.article
  421. * @apiGroup Content
  422. *
  423. * @apiDescription 查看图文内容
  424. *
  425. * @apiParam {String} signature signature
  426. * @apiParam {Number} id 图文id
  427. *
  428. * @apiSuccess {Object[]} info 图文数据
  429. * @apiSuccess {String} info.id
  430. * @apiSuccess {String} info.name 名称
  431. * @apiSuccess {String} info.pic_cover 4:3图片
  432. * @apiSuccess {String} info.pic_cover_169 16:9图片
  433. * @apiSuccess {String} info.type 类型,参考公共参数中的类型设置说明中的type说明,根据它生成path
  434. * @apiSuccess {String} info.pdate 时间
  435. * @apiSuccess {String} info.cate_id 栏目ID
  436. * @apiSuccess {String} info.cate_name 栏目名称
  437. * @apiSuccess {String} info.author_id 作者ID
  438. * @apiSuccess {String} info.author_name 作者名称
  439. * @apiSuccess {String} info.num_view 浏览量
  440. * @apiSuccess {String} info.num_up 喜欢量
  441. * @apiSuccess {String} info.num_comment 评论量
  442. * @apiSuccess {String} info.share_yes 是否显示分享按钮 1显示 2不显示
  443. * @apiSuccess {String} info.share_title 分享标题
  444. * @apiSuccess {String} info.share_pic 分享图片
  445. * @apiSuccess {String} info.share_content 分享内容
  446. * @apiSuccess {String} info.function 开启的功能,这是一个字符串,用逗号隔开的,1代表显示浏览量,2代表显示评论,3代表显示喜欢,如值为1,2,则显示浏览量、评论,不显示喜欢
  447. * @apiSuccess {String} info.content 内容
  448. * @apiSuccess {String} info.content_array 数组内容,请使用该字段循环,type为类型,请参考类型设置说明,content为内容,type为1时为图文内容,type为2时content为视频详情的字段,type为3时content为直播详情的字段,当type为5时content为音频地址,name为标题,cover为封面、type为6时是视频地址,name为标题,cover为封面
  449. *
  450. * @apiSuccess {Object[]} comment 评论列表
  451. * @apiSuccess {String} comment.id
  452. * @apiSuccess {String} comment.username 用户名
  453. * @apiSuccess {String} comment.avatar 头像
  454. * @apiSuccess {String} comment.content 内容
  455. * @apiSuccess {String} comment.num_up 点赞数
  456. * @apiSuccess {String} comment.time 时间,请用这个时间
  457. * @apiSuccess {String} comment.cdate 时间
  458. * @apiSuccess {String} comment.up 是否点赞 1为点赞 2为未点赞
  459. *
  460. * @apiSuccess {Object[]} user_act 用户行为 当用户登录时有效
  461. * @apiSuccess {String} user_act.share 用户分享数
  462. * @apiSuccess {String} user_act.up 是否喜欢1为喜欢,2为未喜欢
  463. */
  464. /**
  465. * @api {get} wonderful/main/?l=view.feature 查看专题内容
  466. * @apiVersion 1.0.0
  467. * @apiName view.feature
  468. * @apiGroup Content
  469. *
  470. * @apiDescription 查看专题内容
  471. *
  472. * @apiParam {String} signature signature
  473. * @apiParam {Number} id 图文id
  474. *
  475. * @apiSuccess {Object[]} info 专题数据
  476. * @apiSuccess {String} info.id
  477. * @apiSuccess {String} info.name 名称
  478. * @apiSuccess {String} info.pic_cover 4:3图片
  479. * @apiSuccess {String} info.pic_cover_169 16:9图片
  480. * @apiSuccess {String} info.type 类型,参考公共参数中的类型设置说明中的type说明,根据它生成path
  481. * @apiSuccess {String} info.pdate 时间
  482. * @apiSuccess {String} info.cate_id 栏目ID
  483. * @apiSuccess {String} info.cate_name 栏目名称
  484. * @apiSuccess {String} info.author_id 作者ID
  485. * @apiSuccess {String} info.author_name 作者名称
  486. * @apiSuccess {String} info.num_view 浏览量
  487. * @apiSuccess {String} info.num_up 喜欢量
  488. * @apiSuccess {String} info.num_comment 评论量
  489. * @apiSuccess {String} info.share_yes 是否显示分享按钮 1显示 2不显示
  490. * @apiSuccess {String} info.share_title 分享标题
  491. * @apiSuccess {String} info.share_pic 分享图片
  492. * @apiSuccess {String} info.share_content 分享内容
  493. * @apiSuccess {String} info.function 开启的功能,这是一个字符串,用逗号隔开的,1代表显示浏览量,2代表显示评论,3代表显示喜欢,如值为1,2,则显示浏览量、评论,不显示喜欢
  494. * @apiSuccess {String} info.content 内容
  495. * @apiSuccess {String} info.content_array 数组内容,请使用该字段循环,type为类型,请参考类型设置说明,content为内容,type为1时为图文内容,type为2时content为视频详情的字段,type为3时content为直播详情的字段,当type为5时content为音频地址,name为标题,cover为封面、type为6时是视频地址,name为标题,cover为封面
  496. *
  497. * @apiSuccess {Object[]} comment 评论列表
  498. * @apiSuccess {String} comment.id
  499. * @apiSuccess {String} comment.username 用户名
  500. * @apiSuccess {String} comment.avatar 头像
  501. * @apiSuccess {String} comment.content 内容
  502. * @apiSuccess {String} comment.num_up 点赞数
  503. * @apiSuccess {String} comment.time 时间,请用这个时间
  504. * @apiSuccess {String} comment.cdate 时间
  505. * @apiSuccess {String} comment.up 是否点赞 1为点赞 2为未点赞
  506. *
  507. * @apiSuccess {Object[]} user_act 用户行为 当用户登录时有效
  508. * @apiSuccess {String} user_act.share 用户分享数
  509. * @apiSuccess {String} user_act.up 是否喜欢1为喜欢,2为未喜欢
  510. */
  511. /**
  512. * @api {get} wonderful/main/?l=view.vod 查看视频内容
  513. * @apiVersion 1.0.0
  514. * @apiName view.vod
  515. * @apiGroup Content
  516. *
  517. * @apiDescription 查看视频内容
  518. *
  519. * @apiParam {String} signature signature
  520. * @apiParam {Number} id 视频id
  521. *
  522. * @apiSuccess {Object[]} info 视频数据
  523. * @apiSuccess {String} info.id
  524. * @apiSuccess {String} info.name 名称
  525. * @apiSuccess {String} info.pic_cover 4:3图片
  526. * @apiSuccess {String} info.pic_cover_169 16:9图片
  527. * @apiSuccess {String} info.type 类型,参考公共参数中的类型设置说明中的type说明,根据它生成path
  528. * @apiSuccess {String} info.pdate 时间
  529. * @apiSuccess {String} info.cate_id 栏目ID
  530. * @apiSuccess {String} info.cate_name 栏目名称
  531. * @apiSuccess {String} info.author_id 作者ID
  532. * @apiSuccess {String} info.author_name 作者名称
  533. * @apiSuccess {String} info.num_view 浏览量
  534. * @apiSuccess {String} info.num_up 喜欢量
  535. * @apiSuccess {String} info.num_comment 评论量
  536. * @apiSuccess {String} info.share_yes 是否显示分享按钮 1显示 2不显示
  537. * @apiSuccess {String} info.share_title 分享标题
  538. * @apiSuccess {String} info.share_pic 分享图片
  539. * @apiSuccess {String} info.share_content 分享内容
  540. * @apiSuccess {String} info.function 开启的功能,这是一个字符串,用逗号隔开的,1代表显示浏览量,2代表显示评论,3代表显示喜欢,4代表显示邀请阅读,如值为1,2,3,则显示浏览量、评论、喜欢,不显示邀请阅读
  541. * @apiSuccess {String} info.content 内容
  542. *
  543. *
  544. * @apiSuccess {Object[]} comment 评论列表
  545. * @apiSuccess {String} comment.id
  546. * @apiSuccess {String} comment.username 用户名
  547. * @apiSuccess {String} comment.avatar 头像
  548. * @apiSuccess {String} comment.content 内容
  549. * @apiSuccess {String} comment.num_up 点赞数
  550. * @apiSuccess {String} comment.cdate 时间
  551. * @apiSuccess {String} comment.up 是否点赞 1为点赞 2为未点赞
  552. *
  553. * @apiSuccess {Object[]} user_act 用户行为 当用户登录时有效
  554. * @apiSuccess {String} user_act.share 用户分享数
  555. * @apiSuccess {String} user_act.up 是否喜欢1为喜欢,2为未喜欢
  556. */
  557. /**
  558. * @api {get} wonderful/main/?l=view.live 查看直播内容
  559. * @apiVersion 1.0.0
  560. * @apiName view.live
  561. * @apiGroup Content
  562. *
  563. * @apiDescription 查看直播内容
  564. *
  565. * @apiParam {String} signature signature
  566. * @apiParam {Number} id 视频id
  567. *
  568. * @apiSuccess {Object[]} info 直播数据
  569. * @apiSuccess {String} info.id
  570. * @apiSuccess {String} info.name 名称
  571. * @apiSuccess {String} info.pic_cover 4:3封面图片
  572. * @apiSuccess {String} info.pic_cover_169 16:9图片
  573. * @apiSuccess {String} info.type 类型,参考公共参数中的类型设置说明中的type说明,根据它生成path
  574. * @apiSuccess {String} info.pdate 时间
  575. * @apiSuccess {String} info.cate_id 栏目ID
  576. * @apiSuccess {String} info.cate_name 栏目名称
  577. * @apiSuccess {String} info.author_id 作者ID
  578. * @apiSuccess {String} info.author_name 作者名称
  579. * @apiSuccess {String} info.sdate_time 开始时间
  580. * @apiSuccess {String} info.edate_time 结束时间
  581. * @apiSuccess {String} info.num_user 在线人数
  582. * @apiSuccess {String} info.num_view 浏览量
  583. * @apiSuccess {String} info.num_up 喜欢量
  584. * @apiSuccess {String} info.num_comment 评论量
  585. * @apiSuccess {String} info.share_yes 是否显示分享按钮 1显示 2不显示
  586. * @apiSuccess {String} info.share_title 分享标题
  587. * @apiSuccess {String} info.share_pic 分享图片
  588. * @apiSuccess {String} info.share_content 分享内容
  589. * @apiSuccess {String} info.function 开启的功能,这是一个字符串,用逗号隔开的,1代表显示浏览量,2代表显示评论,3代表显示喜欢,4代表显示邀请阅读,如值为1,2,3,则显示浏览量、评论、喜欢,不显示邀请阅读
  590. * @apiSuccess {String} info.content 直播介绍
  591. * @apiSuccess {String} info.stream 直播推流地址
  592. * @apiSuccess {String} info.stream_rtmp 直播高清播放地址
  593. * @apiSuccess {String} info.stream_hls 直播标清播放地址
  594. * @apiSuccess {String} info.stream_hdl 直播普清播放地址
  595. * @apiSuccess {String} info.stream_pic 直播截图地址,直播中时,可以用来替代pic_cover
  596. * @apiSuccess {String} info.url 回放播放地址
  597. * @apiSuccess {String} info.status 直播状态1为未开始2为直播中3为已结束
  598. *
  599. *
  600. * @apiSuccess {Object[]} comment 评论列表
  601. * @apiSuccess {String} comment.id
  602. * @apiSuccess {String} comment.username 用户名
  603. * @apiSuccess {String} comment.avatar 头像
  604. * @apiSuccess {String} comment.content 内容
  605. * @apiSuccess {String} comment.num_up 点赞数
  606. * @apiSuccess {String} comment.time 时间,请用这个时间
  607. * @apiSuccess {String} comment.cdate 时间
  608. * @apiSuccess {String} comment.up 是否点赞 1为点赞 2为未点赞
  609. *
  610. * @apiSuccess {Object[]} user_act 用户行为 当用户登录时有效
  611. * @apiSuccess {String} user_act.share 用户分享数
  612. * @apiSuccess {String} user_act.up 是否喜欢1为喜欢,2为未喜欢
  613. * @apiSuccess {String} user_act.note 是否预约提醒1为已预约,2为未预约
  614. */
  615. /**
  616. * @api {get} wonderful/main/?l=user.poster 获取海报
  617. * @apiVersion 1.0.0
  618. * @apiName user.poster
  619. * @apiGroup UserAction
  620. *
  621. * @apiDescription 获取海报
  622. *
  623. * @apiParam {String} signature signature
  624. * @apiParam {Number} type type类型
  625. * @apiParam {Number} id 当前的数据id
  626. * @apiParam {String} path 首页path路径
  627. *
  628. * @apiSuccess {String} img 海报图片
  629. */
  630. /**
  631. * @api {get} wonderful/main/?l=user.submit_up 喜欢
  632. * @apiVersion 1.0.0
  633. * @apiName user.submit_up
  634. * @apiGroup UserAction
  635. *
  636. * @apiDescription 喜欢
  637. *
  638. * @apiParam {String} signature signature
  639. * @apiParam {Number} type type类型 这里增加了一个评论点赞(喜欢),type的值为11就是 给评论点赞
  640. * @apiParam {Number} id 当前的数据id
  641. *
  642. * @apiSuccess {Number} id 当前的数据id
  643. */
  644. /**
  645. * @api {get} wonderful/main/?l=user.submit_note 直播预约提醒
  646. * @apiVersion 1.0.0
  647. * @apiName user.submit_note
  648. * @apiGroup UserAction
  649. *
  650. * @apiDescription 直播预约提醒
  651. *
  652. * @apiParam {String} signature signature
  653. * @apiParam {Number} type type类型
  654. * @apiParam {Number} id 当前的数据id
  655. *
  656. * @apiSuccess {Number} id 当前的数据id
  657. */
  658. /**
  659. * @api {get} wonderful/main/?l=user.submit_share 分享
  660. * @apiVersion 1.0.0
  661. * @apiName user.submit_share
  662. * @apiGroup UserAction
  663. *
  664. * @apiDescription 分享
  665. *
  666. * @apiParam {String} signature signature
  667. * @apiParam {Number} type type类型
  668. * @apiParam {Number} id 当前的数据id
  669. * @apiParam {String} desc 说明:这是分享的说明介绍,请不要传入该参数,底层页分享时,请把路径path设置为首页的path?scene=signature,type,id signature:当前邀请者的signature | type:当前分享的类型 图文等 | id:当前分享的图文的id,小程序中请判断,如果首页有scene参数,请在正常请求首页数据之后,将这几个数据保存到本地,(这里不要发起分享回流接口的请求,请在用户授权用户信息或者授权手机号之后再发起分享回流的接口请求,发起请求之后,请从本地删除这几个数据),然后根据scene参数中的type和id的值,跳转到type所对应的path的详情页即可。
  670. *
  671. * @apiSuccess {Number} id 当前的数据id
  672. */
  673. /**
  674. * @api {get} wonderful/main/?l=user.submit_share_reflux 分享回流
  675. * @apiVersion 1.0.0
  676. * @apiName user.submit_share_reflux
  677. * @apiGroup UserAction
  678. *
  679. * @apiDescription 分享回流
  680. *
  681. * @apiParam {String} signature signature
  682. * @apiParam {Number} type type类型 scene参数中的第二个值
  683. * @apiParam {Number} id 当前的数据id scene参数中的第三个值
  684. * @apiParam {String} source_signature 回流的源用户id,scene参数中的第一个值
  685. *
  686. * @apiSuccess {Number} id 当前的数据id
  687. */
  688. /**
  689. * @api {get} wonderful/main/?l=user.submit_comment 提交评论
  690. * @apiVersion 1.0.0
  691. * @apiName user.submit_comment
  692. * @apiGroup UserAction
  693. *
  694. * @apiDescription 提交评论
  695. *
  696. * @apiParam {String} signature signature
  697. * @apiParam {Number} type type类型
  698. * @apiParam {Number} id 当前的数据id
  699. * @apiParam {String} content 评论内容
  700. *
  701. * @apiSuccess {Number} id 当前的数据id
  702. */
  703. /**
  704. * @api {get} wonderful/main/?l=user.submit_feedback 提交反馈
  705. * @apiVersion 1.0.0
  706. * @apiName user.submit_feedback
  707. * @apiGroup UserAction
  708. *
  709. * @apiDescription 提交反馈
  710. *
  711. * @apiParam {String} signature signature
  712. * @apiParam {String} content 反馈内容 必填
  713. * @apiParam {String} username 用户名 选填
  714. * @apiParam {String} name 反馈标题 选填
  715. *
  716. * @apiSuccess {Number} id 当前的数据id
  717. */
  718. /**
  719. * @api {get} wonderful/main/?l=journal.home 小刊首页
  720. * @apiVersion 1.0.0
  721. * @apiName journal.home
  722. * @apiGroup Journal
  723. *
  724. * @apiDescription 小刊首页
  725. *
  726. * @apiParam {String} signature signature
  727. *
  728. * @apiSuccess {Object[]} journal 小刊数据列表,每页显示10条,请在翻到第7或者第8条时,请求第2页
  729. * @apiSuccess {String} journal.id 小刊id
  730. * @apiSuccess {String} journal.name 名称
  731. * @apiSuccess {String} journal.subname 期号
  732. * @apiSuccess {String} journal.pic_cover 列表封面图片 暂时无效
  733. * @apiSuccess {String} journal.pic_view_cover 小刊封面图片 封面图都用这个
  734. * @apiSuccess {String} journal.pic_view_bg 全屏背景图,多张图片,这是一个数组
  735. * @apiSuccess {String} journal.pic_gd 小刊推广图
  736. * @apiSuccess {String} journal.pdate 时间
  737. * @apiSuccess {String} journal.num_ding 订阅数
  738. * @apiSuccess {String} journal.num_view 浏览量
  739. * @apiSuccess {String} journal.num_comment 评论量
  740. * @apiSuccess {String} journal.buy 小刊是否收费 1收费 2免费 3会员
  741. * @apiSuccess {String} journal.bgmusic 小刊背景音乐
  742. *
  743. * @apiSuccess {Object[]} subscribe 订阅列表
  744. * @apiSuccess {String} subscribe.id
  745. * @apiSuccess {String} subscribe.username 用户名
  746. * @apiSuccess {String} subscribe.avatar 头像
  747. * @apiSuccess {Object[]} push_jingxuan 精选推荐
  748. * @apiSuccess {String} push_jingxuan.name 名称
  749. * @apiSuccess {String} push_jingxuan.pic 图片
  750. * @apiSuccess {String} push_jingxuan.type 类型,这里为4
  751. * @apiSuccess {String} push_jingxuan.id 源表id,这里是小刊的id
  752. * @apiSuccess {String} push_jingxuan.cdate 时间
  753. * @apiSuccess {Number} push_jingxuan_more 是否显示更多按钮1显示2不显示
  754. */
  755. /**
  756. * @api {get} wonderful/main/?l=journal.jingxuan 小刊精选更多
  757. * @apiVersion 1.0.0
  758. * @apiName journal.jingxuan
  759. * @apiGroup Journal
  760. *
  761. * @apiDescription 小刊精选更多
  762. *
  763. * @apiParam {String} signature signature
  764. * @apiSuccess {Object[]} push_jingxuan 精选推荐,这里可以按照page.next_page来获取下一页,无限循环
  765. * @apiSuccess {String} push_jingxuan.name 名称
  766. * @apiSuccess {String} push_jingxuan.pic 图片
  767. * @apiSuccess {String} push_jingxuan.type 类型,这里为4
  768. * @apiSuccess {String} push_jingxuan.id 源表id,这里是小刊的id
  769. * @apiSuccess {String} push_jingxuan.cdate 时间
  770. */
  771. /**
  772. * @api {get} wonderful/main/?l=journal.read 小刊阅读页
  773. * @apiVersion 1.0.0
  774. * @apiName journal.read
  775. * @apiGroup Journal
  776. *
  777. * @apiDescription 小刊阅读页
  778. *
  779. * @apiParam {String} signature signature
  780. * @apiParam {Number} id 小刊id
  781. *
  782. * @apiSuccess {Object[]} content 内容数据列表,每页显示10条,请在翻到第7或者第8条时,请求第2页
  783. * @apiSuccess {String} content.id 内容id
  784. * @apiSuccess {String} content.type 内容类型1全屏图、2长图、3图文内容、11关联图文、12关联视频、13关联直播、4全屏视频、5留言视频、6留言音频
  785. * @apiSuccess {String} content.name 标题。type=5,6时有效
  786. * @apiSuccess {String} content.cover 音频或者视频的封面图,type=4,5,6时有效
  787. * @apiSuccess {String} content.video 视频地址。type=4,5时有效
  788. * @apiSuccess {String} content.music 音频地址。type=6时有效
  789. * @apiSuccess {String} content.pic 全屏图或者长图,type=1,2时有效
  790. * @apiSuccess {String} content.is_button 全屏图上的保存按钮,1显示2不显示,type=1时有效
  791. * @apiSuccess {String} content.button_name 全屏图上的保存按钮的文字,type=1时有效
  792. * @apiSuccess {String} content.button_color 全屏图上的保存按钮的文字颜色,type=1时有效
  793. * @apiSuccess {String} content.note 是否预约提醒1为已预约,2为未预约
  794. * @apiSuccess {Object[]} content.text 全屏图上的九个文字位置,type=1时有效
  795. * @apiSuccess {String} content.text.text 文字位置,1上左2上中3上右4中左5正中6中右7下左8下中9下右
  796. * @apiSuccess {String} content.text.name 文字内容 换行用\n隔开
  797. * @apiSuccess {String} content.text.color 文字颜色
  798. * @apiSuccess {String} content.text.bgcolor 文字背景颜色
  799. * @apiSuccess {String} content.text.bgcolor_type 是否设置文字背景颜色,1设置,2不设置,不设置则文字背景颜色为透明。
  800. * @apiSuccess {String} content.text.size 文字像素大小
  801. * @apiSuccess {Object[]} content.info type=3,11,12,13时有效,当等于11,12,13时,分别对应图文详情、视频详情、直播详情里的字段,等于3时,请查看以下字段
  802. * @apiSuccess {String} content.info.name 标题
  803. * @apiSuccess {String} content.info.focus 焦点图
  804. * @apiSuccess {String} content.info.content 内容
  805. * @apiSuccess {String} content.info.content_array 数组内容
  806. * @apiSuccess {Object[]} content.info.author 作者
  807. */
  808. /**
  809. * @api {get} wonderful/main/?l=journal.view 小刊详情页
  810. * @apiVersion 1.0.0
  811. * @apiName journal.view
  812. * @apiGroup Journal
  813. *
  814. * @apiDescription 小刊详情页
  815. *
  816. * @apiParam {String} signature signature
  817. * @apiParam {Number} id 小刊id
  818. *
  819. * @apiSuccess {Object[]} info 小刊详情
  820. * @apiSuccess {String} info.id 小刊id
  821. * @apiSuccess {String} info.name 名称
  822. * @apiSuccess {String} journal.subname 期号
  823. * @apiSuccess {String} info.pic_cover 列表封面图片 暂时无效
  824. * @apiSuccess {String} info.pic_view_cover 小刊封面图片 封面图都用这个
  825. * @apiSuccess {String} info.pic_view_bg 全屏背景图,多张图片,这是一个数组
  826. * @apiSuccess {String} info.pic_gd 小刊推广图
  827. * @apiSuccess {String} info.pdate 时间
  828. * @apiSuccess {String} info.num_ding 订阅数
  829. * @apiSuccess {String} info.num_view 浏览量
  830. * @apiSuccess {String} info.num_comment 评论量
  831. * @apiSuccess {String} info.buy 小刊是否收费 1收费 2不收费
  832. * @apiSuccess {String} info.subscribe 是否订阅,1为已订阅2为未订阅
  833. * @apiSuccess {String} info.active 是否有活动,1为有2为没有,有则显示分享邀请按钮
  834. * @apiSuccess {Object[]} button 按钮判断 如果不需要这个,可以不用
  835. * @apiSuccess {Object[]} button.read 第一个按钮 一般为购买按钮
  836. * @apiSuccess {String} button.read.status 状态 -1不显示 1为进入阅读 2为购买
  837. * @apiSuccess {String} button.read.name 按钮上的名字
  838. * @apiSuccess {Object[]} button.code 第二个按钮 一般为兑换码按钮
  839. * @apiSuccess {String} button.code.status 状态 -1不显示 1为兑换码兑换 2为购买(再次购买)
  840. * @apiSuccess {String} button.code.name 按钮上的名字
  841. * @apiSuccess {Object[]} button.share 第三个按钮 一般为分享邀请按钮
  842. * @apiSuccess {String} button.share.status 状态 -1不显示 1为免费阅读赢取大礼包
  843. * @apiSuccess {String} button.share.name 按钮上的名字
  844. */
  845. /**
  846. * @api {get} wonderful/main/?l=journal.active 小刊活动页
  847. * @apiVersion 1.0.0
  848. * @apiName journal.active
  849. * @apiGroup Journal
  850. *
  851. * @apiDescription 小刊活动页
  852. *
  853. * @apiParam {String} signature signature
  854. * @apiParam {Number} id 小刊id
  855. *
  856. * @apiSuccess {Object[]} info 小刊详情
  857. * @apiSuccess {String} info.id 小刊id
  858. * @apiSuccess {String} info.name 名称
  859. *
  860. * @apiSuccess {Object[]} active 活动说明表
  861. * @apiSuccess {String} active.name 名称
  862. * @apiSuccess {String} active.status 活动状态 1活动进行中 2活动已结束
  863. * @apiSuccess {String} active.desc 描述
  864. * @apiSuccess {String} active.buy_title 购买标题
  865. * @apiSuccess {String} active.buy_desc 购买描述
  866. * @apiSuccess {String} active.invite_title 邀请好友标题
  867. * @apiSuccess {String} active.invite_desc 邀请好友描述 换行用\n隔开
  868. * @apiSuccess {String} active.content 活动说明,富文本
  869. * @apiSuccess {Object[]} invite 我的邀请
  870. * @apiSuccess {String} invite.uid 用户id
  871. * @apiSuccess {String} invite.username 用户名
  872. * @apiSuccess {String} invite.avatar 头像
  873. * @apiSuccess {String} buy 是否显示购买按钮,1显示,2不显示
  874. */
  875. /**
  876. * @api {get} wonderful/main/?l=journal.buy 小刊购买页
  877. * @apiVersion 1.0.0
  878. * @apiName journal.buy
  879. * @apiGroup Journal
  880. *
  881. * @apiDescription 小刊购买页
  882. *
  883. * @apiParam {String} signature signature
  884. * @apiParam {Number} id 小刊id
  885. *
  886. * @apiSuccess {Object[]} info 小刊详情
  887. * @apiSuccess {String} info.id 小刊id
  888. * @apiSuccess {String} info.name 名称
  889. *
  890. * @apiSuccess {String} buy_desc 购买说明
  891. * @apiSuccess {Object[]} buy_list 购买列表
  892. * @apiSuccess {String} buy_list.id 购买id 支付时使用
  893. * @apiSuccess {String} buy_list.name 名称
  894. * @apiSuccess {String} buy_list.price 标价
  895. * @apiSuccess {String} buy_list.cash 实际支付价格
  896. */
  897. /**
  898. * @api {get} wonderful/main/?l=journal.buy_action 发起支付
  899. * @apiVersion 1.0.0
  900. * @apiName journal.buy_action
  901. * @apiGroup Journal
  902. *
  903. * @apiDescription 发起支付:请注意,如果是苹果支付,请在发起苹果支付之后,将苹果返回的验证数据,传入该接口
  904. *
  905. * @apiParam {String} signature signature
  906. * @apiParam {String} journal_id 小刊id
  907. * @apiParam {String} buy_id 购买本数id
  908. * @apiParam {String} receipt 当header中的source_type为ios时,请传入该参数,参数的值为苹果支付后返回的参数,即可发起支付验证。
  909. *
  910. * @apiSuccess {Object[]} pay 微信支付返回的数据
  911. * @apiSuccess {String} pay.time 服务器时间戳
  912. * @apiSuccess {String} pay.nonce_str 随机字符串
  913. * @apiSuccess {String} pay.prepay_id 统一下单接口返回的 prepay_id 参数值,通过'prepay_id=' + prepay_id 拼装成package
  914. * @apiSuccess {String} pay.sign_type 签名算法
  915. * @apiSuccess {String} pay.sign 签名
  916. * @apiSuccess {String} pay.yes 苹果支付时显示改参数,1为支付成功2为支付失败
  917. */
  918. /**
  919. * @api {get} wonderful/main/?l=journal.code 提交兑换码
  920. * @apiVersion 1.0.0
  921. * @apiName journal.code
  922. * @apiGroup Journal
  923. * @apiDescription 提交兑换码
  924. *
  925. * @apiParam {String} signature signature
  926. * @apiParam {String} journal_id 小刊id
  927. * @apiParam {String} code 兑换码
  928. *
  929. * @apiSuccess {String} order_id 兑换成功则返回订单id
  930. */
  931. /**
  932. * @api {get} wonderful/main/?l=journal.checkCode 验证兑换码是否有效
  933. * @apiVersion 1.0.0
  934. * @apiName journal.checkCode
  935. * @apiGroup Journal
  936. *
  937. * @apiDescription 验证兑换码是否有效
  938. *
  939. * @apiParam {String} signature signature
  940. * @apiParam {String} code 兑换码
  941. * @apiSuccess {Object[]} product 小刊信息
  942. * @apiSuccess {String} product.id 小刊id
  943. * @apiSuccess {String} product.name 小刊名称
  944. */
  945. /**
  946. * @api {get} wonderful/main/?l=journal.score 小刊积分排行榜
  947. * @apiVersion 1.0.0
  948. * @apiName journal.score
  949. * @apiGroup Journal
  950. *
  951. * @apiDescription 小刊积分排行榜
  952. *
  953. * @apiParam {String} signature signature
  954. * @apiParam {Number} id 小刊id
  955. *
  956. * @apiSuccess {Object[]} info 小刊详情
  957. * @apiSuccess {String} info.id 小刊id
  958. * @apiSuccess {String} info.name 名称
  959. *
  960. * @apiSuccess {Object[]} score 积分排行
  961. * @apiSuccess {String} score.uid 用户id
  962. * @apiSuccess {String} score.score 积分数
  963. * @apiSuccess {String} score.username 用户名
  964. * @apiSuccess {String} score.avatar 头像
  965. *
  966. * @apiSuccess {Object[]} active 活动说明表
  967. * @apiSuccess {String} active.name 名称
  968. * @apiSuccess {String} active.status 活动状态 1活动进行中 2活动已结束
  969. * @apiSuccess {String} active.desc 描述
  970. * @apiSuccess {String} active.invite_title 邀请好友标题
  971. * @apiSuccess {String} active.invite_desc 邀请好友描述 换行用\n隔开
  972. * @apiSuccess {String} active.content 活动说明,富文本
  973. */
  974. /**
  975. * @api {get} wonderful/main/?l=journal.invite 小刊我的邀请排行榜
  976. * @apiVersion 1.0.0
  977. * @apiName journal.invite
  978. * @apiGroup Journal
  979. *
  980. * @apiDescription 小刊邀请排行榜
  981. *
  982. * @apiParam {String} signature signature
  983. * @apiParam {Number} id 小刊id
  984. *
  985. * @apiSuccess {Object[]} info 小刊详情
  986. * @apiSuccess {String} info.id 小刊id
  987. * @apiSuccess {String} info.name 名称
  988. *
  989. * @apiSuccess {Object[]} invite 邀请排行
  990. * @apiSuccess {String} invite.uid 用户id
  991. * @apiSuccess {String} invite.username 用户名
  992. * @apiSuccess {String} invite.avatar 头像
  993. */
  994. /**
  995. * @api {get} wonderful/main/?l=user.my 获取用户信息
  996. * @apiVersion 1.0.0
  997. * @apiName user.my
  998. * @apiGroup User
  999. *
  1000. * @apiDescription 获取用户信息
  1001. *
  1002. * @apiParam {String} signature signature
  1003. *
  1004. * @apiSuccess {Object[]} user 用户基本信息
  1005. * @apiSuccess {String} user.id 用户id
  1006. * @apiSuccess {String} user.username 用户名
  1007. * @apiSuccess {String} user.mobile 手机号
  1008. * @apiSuccess {String} user.avatar 头像
  1009. * @apiSuccess {String} user.level 等级
  1010. * @apiSuccess {String} user.score 积分
  1011. * @apiSuccess {Number} user_msg 用户新消息数
  1012. */
  1013. /**
  1014. * @api {get} wonderful/main/?l=user.my_msg 获取我的消息
  1015. * @apiVersion 1.0.0
  1016. * @apiName user.my_msg
  1017. * @apiGroup User
  1018. *
  1019. * @apiDescription 获取我的消息
  1020. *
  1021. * @apiParam {String} signature signature
  1022. *
  1023. * @apiSuccess {Object[]} msg 消息列表
  1024. * @apiSuccess {String} msg.uid 用户id
  1025. * @apiSuccess {String} msg.from_uid 消息来源uid,暂时不用管
  1026. * @apiSuccess {String} msg.name 消息标题
  1027. * @apiSuccess {String} msg.content 消息内容
  1028. * @apiSuccess {String} msg.cdate 时间戳
  1029. * @apiSuccess {String} msg.cdate_time 转换成了Y-m-d H:i:s的时间
  1030. * @apiSuccess {String} msg.status 消息已读状态1未读2已读
  1031. * @apiSuccess {String} msg.type 消息类型,暂时不用管
  1032. */
  1033. /**
  1034. * @api {get} wonderful/main/?l=user.my_up 获取我喜欢的信息
  1035. * @apiVersion 1.0.0
  1036. * @apiName user.my_up
  1037. * @apiGroup User
  1038. *
  1039. * @apiDescription 获取我喜欢的信息
  1040. *
  1041. * @apiParam {String} signature signature
  1042. *
  1043. * @apiSuccess {Object[]} like 用户基本信息
  1044. * @apiSuccess {String} like.uid 用户id
  1045. * @apiSuccess {String} like.data_id 数据id
  1046. * @apiSuccess {String} like.cdate 时间戳
  1047. * @apiSuccess {String} like.cdate_time 转换成了Y-m-d H:i:s的时间
  1048. * @apiSuccess {String} like.type 类型,参考公共参数中的类型设置说明中的type说明
  1049. * @apiSuccess {Object[]} like.info 基本信息 根据type不同,里面的字段有所不同
  1050. * @apiSuccess {String} like.info.id 数据id
  1051. * @apiSuccess {String} like.info.name 名称
  1052. * @apiSuccess {String} like.info.cate_id 栏目ID
  1053. * @apiSuccess {String} like.info.cate_name 栏目名称
  1054. * @apiSuccess {String} like.info.pic_cover 4:3图片
  1055. * @apiSuccess {String} like.info.pic_cover_169 16:9图片
  1056. * @apiSuccess {String} like.info.pdate 发布时间
  1057. */
  1058. /**
  1059. * @api {get} wonderful/main/?l=user.my_comment 获取我评论的信息
  1060. * @apiVersion 1.0.0
  1061. * @apiName user.my_comment
  1062. * @apiGroup User
  1063. *
  1064. * @apiDescription 获取我喜欢的信息
  1065. *
  1066. * @apiParam {String} signature signature
  1067. *
  1068. * @apiSuccess {Object[]} comment 用户基本信息
  1069. * @apiSuccess {String} comment.uid 用户id
  1070. * @apiSuccess {String} comment.data_id 数据id
  1071. * @apiSuccess {String} comment.content 评论内容
  1072. * @apiSuccess {String} comment.time 时间:x小时前
  1073. * @apiSuccess {String} comment.cdate 时间戳
  1074. * @apiSuccess {String} comment.cdate_time 转换成了Y-m-d H:i:s的时间
  1075. * @apiSuccess {String} comment.type 类型,参考公共参数中的类型设置说明中的type说明
  1076. * @apiSuccess {Object[]} comment.info 基本信息 根据type不同,里面的字段有所不同
  1077. * @apiSuccess {String} comment.info.id 数据id
  1078. * @apiSuccess {String} comment.info.name 名称
  1079. * @apiSuccess {String} comment.info.cate_id 栏目ID
  1080. * @apiSuccess {String} comment.info.cate_name 栏目名称
  1081. * @apiSuccess {String} comment.info.pic_cover 4:3图片
  1082. * @apiSuccess {String} comment.info.pic_cover_169 16:9图片
  1083. * @apiSuccess {String} comment.info.pdate 发布时间
  1084. */