apidoc.php 48 KB

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