apidoc.php 36 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923
  1. <?php
  2. /**
  3. * @api {get} common.public 公共参数说明
  4. * @apiVersion 1.0.0
  5. * @apiName common.public
  6. * @apiGroup Common
  7. *
  8. * @apiDescription 介绍公共参数
  9. *
  10. * @apiParam {Number} json 是否返回json格式的数据1为返回2为不返回
  11. * @apiParam {Number} signature 用于登录后的uid验证,每次都要传入,请登录后将这个值保存在本地
  12. * @apiParam {Number} pg 分页数,第几页,列表页瀑布流使用该参数
  13. *
  14. * @apiSuccess {Number} status 状态,1为有效2为无效
  15. * @apiSuccess {String} msg 请求的数据是否成功的提示
  16. * @apiSuccess {String} data 如果status为1,data有值
  17. * @apiSuccess {Object[]} page 分页信息
  18. * @apiSuccess {Number} page.total 分页总数
  19. * @apiSuccess {Number} page.current_page 当前页
  20. * @apiSuccess {Number} page.total_page 总页数
  21. * @apiSuccess {Number} page.next_page 下一页
  22. * @apiSuccess {Number} page.prev_page 上一页
  23. * @apiSuccess {Number} page.status 是否有下一页数据,0为没有
  24. */
  25. /**
  26. * @api {get} common.type 类型设置说明
  27. * @apiVersion 1.0.0
  28. * @apiName common.type
  29. * @apiGroup Common
  30. *
  31. * @apiDescription 类型设置说明
  32. *
  33. * @apiParam {String} source_type 请在header中定义,ios:ios | android:android | 移动h5:h5 | 小程序:applet | 公众号:service | pc网站:pc
  34. * @apiParam {Number} type 图文:1 | 视频:2 | 直播:3 | 小刊:4 | 音视频:5 | 链接:10 | 评论: 11
  35. * @apiParam {Number} push_ 所有带push_开头的返回参数,返回字典都是一样的,参考获取首页数据中的push_focus
  36. */
  37. /**
  38. * @api {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.update 更新用户信息
  175. * @apiVersion 1.0.0
  176. * @apiName app.update
  177. * @apiGroup AppPassport
  178. *
  179. * @apiDescription 更新用户信息
  180. *
  181. * @apiParam {Number} signature 用户signature
  182. * @apiParam {String} avatar 头像
  183. * @apiParam {String} gender 性别
  184. * @apiParam {String} city 城市
  185. * @apiParam {String} province 省份
  186. * @apiParam {String} country 县区
  187. *
  188. * @apiSuccess {Number} uid 用户id,请保存在本地
  189. * @apiSuccess {String} signature 用于登录后的uid验证,每次都要传入,请登录后将这个值保存在本地
  190. */
  191. /**
  192. * @api {get} wonderful/live/?l=api.get 获取直播推流信息
  193. * @apiVersion 1.0.0
  194. * @apiName api.get
  195. * @apiGroup Live
  196. *
  197. * @apiDescription 获取直播推流信息
  198. *
  199. * @apiParam {String} signature 请将字符串signature_dever_2018_jm经过md5加密
  200. *
  201. * @apiSuccess {Object[]} active 直播活动列表
  202. * @apiSuccess {String} active.id 活动id
  203. * @apiSuccess {String} acitve.name 活动名称
  204. * @apiSuccess {Object[]} active.stream 直播流列表
  205. * @apiSuccess {String} active.stream.id 推流id
  206. * @apiSuccess {String} active.stream.live 推流实际地址
  207. * @apiSuccess {String} active.stream.url_rtmp 播放地址
  208. * @apiSuccess {String} active.stream.url_hls 播放地址
  209. * @apiSuccess {String} active.stream.url_hdl 播放地址
  210. * @apiSuccess {String} active.stream.url_pic 实时截图地址
  211. */
  212. /**
  213. * @api {get} wonderful/live/?l=api.start 开始推流
  214. * @apiVersion 1.0.0
  215. * @apiName api.start
  216. * @apiGroup Live
  217. *
  218. * @apiDescription 开始推流
  219. *
  220. * @apiParam {String} signature 请将字符串signature_dever_2018_jm经过md5加密
  221. * @apiParam {Number} id 推流id
  222. *
  223. * @apiSuccess {Number} id 推流id
  224. * @apiSuccess {Number} log_id 本次推流日志id
  225. */
  226. /**
  227. * @api {get} wonderful/live/?l=api.stop 结束推流
  228. * @apiVersion 1.0.0
  229. * @apiName api.stop
  230. * @apiGroup Live
  231. *
  232. * @apiDescription 结束推流 一定要调用该接口,否则不会生成回放地址
  233. *
  234. * @apiParam {String} signature 请将字符串signature_dever_2018_jm经过md5加密
  235. * @apiParam {Number} id 推流id
  236. * @apiParam {Number} log_id 本次推流日志id
  237. */
  238. /**
  239. * @api {get} wonderful/main/?l=content.home 获取首页数据
  240. * @apiVersion 1.0.0
  241. * @apiName content.home
  242. * @apiGroup Content
  243. *
  244. * @apiDescription 获取首页数据
  245. *
  246. * @apiParam {String} signature signature
  247. *
  248. *
  249. * @apiSuccess {Number} uid 用户id 所有接口中都有该项
  250. * @apiSuccess {Object[]} config 基本配置 所有接口中都有该项
  251. * @apiSuccess {String} config.name 系统名称 请将小程序和app头部名称替换为该字段
  252. * @apiSuccess {String} config.info 系统介绍
  253. * @apiSuccess {String} config.logo 系统logo
  254. * @apiSuccess {Object[]} menu 栏目
  255. * @apiSuccess {String} menu.name 名称
  256. * @apiSuccess {String} menu.id 栏目id,访问content.news时可以使用menu=menu.id
  257. * @apiSuccess {Object[]} push_focus 焦点图
  258. * @apiSuccess {String} push_focus.name 名称
  259. * @apiSuccess {String} push_focus.pic 图片
  260. * @apiSuccess {String} push_focus.type 类型,参考公共参数中的类型设置说明中的type说明
  261. * @apiSuccess {String} push_focus.id 源表id,根据type计算路径,然后把这个id加上就是最终的path,小程序和app同样。如果没有id,则进入type相对应的列表。请做好判断!!
  262. * @apiSuccess {String} push_focus.link 当type==10时有效,链接
  263. * @apiSuccess {String} push_focus.cdate 时间
  264. * @apiSuccess {Object[]} push_link 精选分类,字段同上
  265. * @apiSuccess {Object[]} push_ad 广告位,字段同上
  266. * @apiSuccess {Object[]} push_open_ad 弹窗广告位,字段同上
  267. * @apiSuccess {Object[]} push_up 精选推荐,字段同上
  268. * @apiSuccess {Object[]} news 更多图文等数据
  269. * @apiSuccess {String} news.id 图文id
  270. * @apiSuccess {String} news.name 名称
  271. * @apiSuccess {String} news.pic_cover 图片
  272. * @apiSuccess {String} news.type 类型,参考公共参数中的类型设置说明中的type说明,根据它生成path
  273. * @apiSuccess {String} news.pdate 时间
  274. * @apiSuccess {String} news.num_view 浏览量
  275. * @apiSuccess {String} news.num_up 喜欢量
  276. * @apiSuccess {String} news.num_comment 评论量
  277. * @apiSuccess {String} news.num_ding 订阅量
  278. * @apiSuccess {String} news.num_user 在线人数
  279. * @apiSuccess {String} news.share_yes 是否显示分享按钮 1显示 2不显示
  280. * @apiSuccess {String} news.share_title 分享标题
  281. * @apiSuccess {String} news.share_pic 分享图片
  282. * @apiSuccess {String} news.share_content 分享内容
  283. */
  284. /**
  285. * @api {get} wonderful/main/?l=content.up 精选推荐更多
  286. * @apiVersion 1.0.0
  287. * @apiName content.up
  288. * @apiGroup Content
  289. *
  290. * @apiDescription 精选推荐更多
  291. *
  292. * @apiParam {String} signature signature
  293. *
  294. *
  295. * @apiSuccess {Object[]} push_up 栏目,字段同上
  296. * @apiSuccess {String} push_up.name 名称
  297. * @apiSuccess {String} push_up.pic 图片
  298. * @apiSuccess {String} push_up.type 类型,参考公共参数中的类型设置说明中的type说明
  299. * @apiSuccess {String} push_up.id 源表id,根据type计算路径,然后把这个source_id加上就是最终的path,小程序和app同样。
  300. * @apiSuccess {String} push_up.link 当type==10时有效,链接
  301. * @apiSuccess {String} push_up.cdate 时间
  302. */
  303. /**
  304. * @api {get} wonderful/main/?l=content.news 精选页图文内容下拉更多
  305. * @apiVersion 1.0.0
  306. * @apiName content.news
  307. * @apiGroup Content
  308. *
  309. * @apiDescription 精选页图文内容下拉更多
  310. *
  311. * @apiParam {String} signature signature
  312. * @apiParam {Number} menu 可选参数,栏目id
  313. * @apiParam {Number} type 可选参数,类型1为图文、2为视频、3为直播,小刊请到专门的接口获取
  314. *
  315. * @apiSuccess {Object[]} news 更多图文等数据
  316. * @apiSuccess {String} news.id 图文id
  317. * @apiSuccess {String} news.name 名称
  318. * @apiSuccess {String} news.pic_cover 图片
  319. * @apiSuccess {String} news.type 类型,参考公共参数中的类型设置说明中的type说明,根据它生成path
  320. * @apiSuccess {String} news.pdate 时间
  321. * @apiSuccess {String} news.num_view 浏览量
  322. * @apiSuccess {String} news.num_up 喜欢量
  323. * @apiSuccess {String} news.num_comment 评论量
  324. * @apiSuccess {String} news.num_ding 订阅量
  325. * @apiSuccess {String} news.num_user 在线人数
  326. * @apiSuccess {String} news.share_yes 是否显示分享按钮 1显示 2不显示
  327. * @apiSuccess {String} news.share_title 分享标题
  328. * @apiSuccess {String} news.share_pic 分享图片
  329. * @apiSuccess {String} news.share_content 分享内容
  330. */
  331. /**
  332. * @api {get} wonderful/main/?l=view.comment 查看评论列表
  333. * @apiVersion 1.0.0
  334. * @apiName view.comment
  335. * @apiGroup Content
  336. *
  337. * @apiDescription 查看评论列表
  338. *
  339. * @apiParam {String} signature signature
  340. * @apiParam {Number} id 图文id
  341. * @apiParam {Number} type 类型,参考公共参数中的类型设置说明中的type说明
  342. *
  343. * @apiSuccess {Object[]} comment 评论列表
  344. * @apiSuccess {String} comment.id
  345. * @apiSuccess {String} comment.username 用户名
  346. * @apiSuccess {String} comment.avatar 头像
  347. * @apiSuccess {String} comment.content 内容
  348. * @apiSuccess {String} comment.num_up 点赞数
  349. * @apiSuccess {String} comment.cdate 时间
  350. * @apiSuccess {String} comment.up 是否点赞 1为点赞 2为未点赞
  351. */
  352. /**
  353. * @api {get} wonderful/main/?l=view.article 查看图文内容
  354. * @apiVersion 1.0.0
  355. * @apiName view.article
  356. * @apiGroup Content
  357. *
  358. * @apiDescription 查看图文内容
  359. *
  360. * @apiParam {String} signature signature
  361. * @apiParam {Number} id 图文id
  362. *
  363. * @apiSuccess {Object[]} info 图文数据
  364. * @apiSuccess {String} info.id
  365. * @apiSuccess {String} info.name 名称
  366. * @apiSuccess {String} info.pic_cover 图片
  367. * @apiSuccess {String} info.type 类型,参考公共参数中的类型设置说明中的type说明,根据它生成path
  368. * @apiSuccess {String} info.pdate 时间
  369. * @apiSuccess {String} info.cate_id 栏目ID
  370. * @apiSuccess {String} info.cate_name 栏目名称
  371. * @apiSuccess {String} info.author_id 作者ID
  372. * @apiSuccess {String} info.author_name 作者名称
  373. * @apiSuccess {String} info.num_view 浏览量
  374. * @apiSuccess {String} info.num_up 喜欢量
  375. * @apiSuccess {String} info.num_comment 评论量
  376. * @apiSuccess {String} info.share_yes 是否显示分享按钮 1显示 2不显示
  377. * @apiSuccess {String} info.share_title 分享标题
  378. * @apiSuccess {String} info.share_pic 分享图片
  379. * @apiSuccess {String} info.share_content 分享内容
  380. * @apiSuccess {String} info.function 开启的功能,这是一个字符串,用逗号隔开的,1代表显示浏览量,2代表显示评论,3代表显示喜欢,如值为1,2,则显示浏览量、评论,不显示喜欢
  381. * @apiSuccess {String} info.content 内容
  382. * @apiSuccess {String} info.content_array 数组内容,请使用该字段循环,type为类型,请参考类型设置说明,content为内容,type为1时为图文内容,type为2时content为视频详情的字段,type为3时content为直播详情的字段,type为5时content为音频或者视频地址
  383. *
  384. * @apiSuccess {Object[]} comment 评论列表
  385. * @apiSuccess {String} comment.id
  386. * @apiSuccess {String} comment.username 用户名
  387. * @apiSuccess {String} comment.avatar 头像
  388. * @apiSuccess {String} comment.content 内容
  389. * @apiSuccess {String} comment.num_up 点赞数
  390. * @apiSuccess {String} comment.cdate 时间
  391. * @apiSuccess {String} comment.up 是否点赞 1为点赞 2为未点赞
  392. *
  393. * @apiSuccess {Object[]} user_act 用户行为 当用户登录时有效
  394. * @apiSuccess {String} user_act.share 用户分享数
  395. * @apiSuccess {String} user_act.up 是否喜欢1为喜欢,2为未喜欢
  396. */
  397. /**
  398. * @api {get} wonderful/main/?l=view.vod 查看视频内容
  399. * @apiVersion 1.0.0
  400. * @apiName view.vod
  401. * @apiGroup Content
  402. *
  403. * @apiDescription 查看视频内容
  404. *
  405. * @apiParam {String} signature signature
  406. * @apiParam {Number} id 视频id
  407. *
  408. * @apiSuccess {Object[]} info 视频数据
  409. * @apiSuccess {String} info.id
  410. * @apiSuccess {String} info.name 名称
  411. * @apiSuccess {String} info.pic_cover 图片
  412. * @apiSuccess {String} info.type 类型,参考公共参数中的类型设置说明中的type说明,根据它生成path
  413. * @apiSuccess {String} info.pdate 时间
  414. * @apiSuccess {String} info.cate_id 栏目ID
  415. * @apiSuccess {String} info.cate_name 栏目名称
  416. * @apiSuccess {String} info.author_id 作者ID
  417. * @apiSuccess {String} info.author_name 作者名称
  418. * @apiSuccess {String} info.num_view 浏览量
  419. * @apiSuccess {String} info.num_up 喜欢量
  420. * @apiSuccess {String} info.num_comment 评论量
  421. * @apiSuccess {String} info.share_yes 是否显示分享按钮 1显示 2不显示
  422. * @apiSuccess {String} info.share_title 分享标题
  423. * @apiSuccess {String} info.share_pic 分享图片
  424. * @apiSuccess {String} info.share_content 分享内容
  425. * @apiSuccess {String} info.function 开启的功能,这是一个字符串,用逗号隔开的,1代表显示浏览量,2代表显示评论,3代表显示喜欢,4代表显示邀请阅读,如值为1,2,3,则显示浏览量、评论、喜欢,不显示邀请阅读
  426. * @apiSuccess {String} info.content 内容
  427. *
  428. *
  429. * @apiSuccess {Object[]} comment 评论列表
  430. * @apiSuccess {String} comment.id
  431. * @apiSuccess {String} comment.username 用户名
  432. * @apiSuccess {String} comment.avatar 头像
  433. * @apiSuccess {String} comment.content 内容
  434. * @apiSuccess {String} comment.num_up 点赞数
  435. * @apiSuccess {String} comment.cdate 时间
  436. * @apiSuccess {String} comment.up 是否点赞 1为点赞 2为未点赞
  437. *
  438. * @apiSuccess {Object[]} user_act 用户行为 当用户登录时有效
  439. * @apiSuccess {String} user_act.share 用户分享数
  440. * @apiSuccess {String} user_act.up 是否喜欢1为喜欢,2为未喜欢
  441. */
  442. /**
  443. * @api {get} wonderful/main/?l=view.live 查看直播内容
  444. * @apiVersion 1.0.0
  445. * @apiName view.live
  446. * @apiGroup Content
  447. *
  448. * @apiDescription 查看直播内容
  449. *
  450. * @apiParam {String} signature signature
  451. * @apiParam {Number} id 视频id
  452. *
  453. * @apiSuccess {Object[]} info 直播数据
  454. * @apiSuccess {String} info.id
  455. * @apiSuccess {String} info.name 名称
  456. * @apiSuccess {String} info.pic_cover 封面图片
  457. * @apiSuccess {String} info.type 类型,参考公共参数中的类型设置说明中的type说明,根据它生成path
  458. * @apiSuccess {String} info.pdate 时间
  459. * @apiSuccess {String} info.cate_id 栏目ID
  460. * @apiSuccess {String} info.cate_name 栏目名称
  461. * @apiSuccess {String} info.author_id 作者ID
  462. * @apiSuccess {String} info.author_name 作者名称
  463. * @apiSuccess {String} info.sdate_time 开始时间
  464. * @apiSuccess {String} info.edate_time 结束时间
  465. * @apiSuccess {String} info.num_user 在线人数
  466. * @apiSuccess {String} info.num_view 浏览量
  467. * @apiSuccess {String} info.num_up 喜欢量
  468. * @apiSuccess {String} info.num_comment 评论量
  469. * @apiSuccess {String} info.share_yes 是否显示分享按钮 1显示 2不显示
  470. * @apiSuccess {String} info.share_title 分享标题
  471. * @apiSuccess {String} info.share_pic 分享图片
  472. * @apiSuccess {String} info.share_content 分享内容
  473. * @apiSuccess {String} info.function 开启的功能,这是一个字符串,用逗号隔开的,1代表显示浏览量,2代表显示评论,3代表显示喜欢,4代表显示邀请阅读,如值为1,2,3,则显示浏览量、评论、喜欢,不显示邀请阅读
  474. * @apiSuccess {String} info.content 直播介绍
  475. * @apiSuccess {String} info.stream 直播推流地址
  476. * @apiSuccess {String} info.stream_rtmp 直播高清播放地址
  477. * @apiSuccess {String} info.stream_hls 直播标清播放地址
  478. * @apiSuccess {String} info.stream_hdl 直播普清播放地址
  479. * @apiSuccess {String} info.stream_pic 直播截图地址,直播中时,可以用来替代pic_cover
  480. * @apiSuccess {String} info.url_mp4 回放播放地址
  481. * @apiSuccess {String} info.status 直播状态1为未开始2为直播中3为已结束
  482. *
  483. *
  484. * @apiSuccess {Object[]} comment 评论列表
  485. * @apiSuccess {String} comment.id
  486. * @apiSuccess {String} comment.username 用户名
  487. * @apiSuccess {String} comment.avatar 头像
  488. * @apiSuccess {String} comment.content 内容
  489. * @apiSuccess {String} comment.num_up 点赞数
  490. * @apiSuccess {String} comment.cdate 时间
  491. * @apiSuccess {String} comment.up 是否点赞 1为点赞 2为未点赞
  492. *
  493. * @apiSuccess {Object[]} user_act 用户行为 当用户登录时有效
  494. * @apiSuccess {String} user_act.share 用户分享数
  495. * @apiSuccess {String} user_act.up 是否喜欢1为喜欢,2为未喜欢
  496. * @apiSuccess {String} user_act.note 是否预约提醒1为已预约,2为未预约
  497. */
  498. /**
  499. * @api {get} wonderful/main/?l=user.submit_up 喜欢
  500. * @apiVersion 1.0.0
  501. * @apiName user.submit_up
  502. * @apiGroup UserAction
  503. *
  504. * @apiDescription 喜欢
  505. *
  506. * @apiParam {String} signature signature
  507. * @apiParam {Number} type type类型 这里增加了一个评论点赞(喜欢),type的值为11就是 给评论点赞
  508. * @apiParam {Number} id 当前的数据id
  509. *
  510. * @apiSuccess {Number} id 当前的数据id
  511. */
  512. /**
  513. * @api {get} wonderful/main/?l=user.submit_note 直播预约提醒
  514. * @apiVersion 1.0.0
  515. * @apiName user.submit_note
  516. * @apiGroup UserAction
  517. *
  518. * @apiDescription 直播预约提醒
  519. *
  520. * @apiParam {String} signature signature
  521. * @apiParam {Number} type type类型
  522. * @apiParam {Number} id 当前的数据id
  523. *
  524. * @apiSuccess {Number} id 当前的数据id
  525. */
  526. /**
  527. * @api {get} wonderful/main/?l=user.submit_share 分享
  528. * @apiVersion 1.0.0
  529. * @apiName user.submit_share
  530. * @apiGroup UserAction
  531. *
  532. * @apiDescription 分享
  533. *
  534. * @apiParam {String} signature signature
  535. * @apiParam {Number} type type类型
  536. * @apiParam {Number} id 当前的数据id
  537. * @apiParam {String} desc 说明:这是分享的说明介绍,请不要传入该参数,底层页分享时,请把路径path设置为首页的path?scene=signature,type,id signature:当前邀请者的signature | type:当前分享的类型 图文等 | id:当前分享的图文的id,小程序中请判断,如果首页有scene参数,请在正常请求首页数据之后,先发起分享回流接口的请求,然后根据scene参数中的type和id的值,跳转到type所对应的path的详情页即可。
  538. *
  539. * @apiSuccess {Number} id 当前的数据id
  540. */
  541. /**
  542. * @api {get} wonderful/main/?l=user.submit_share_reflux 分享回流
  543. * @apiVersion 1.0.0
  544. * @apiName user.submit_share_reflux
  545. * @apiGroup UserAction
  546. *
  547. * @apiDescription 分享回流
  548. *
  549. * @apiParam {String} signature signature
  550. * @apiParam {Number} type type类型 scene参数中的第二个值
  551. * @apiParam {Number} id 当前的数据id scene参数中的第三个值
  552. * @apiParam {String} source_signature 回流的源用户id,scene参数中的第一个值
  553. *
  554. * @apiSuccess {Number} id 当前的数据id
  555. */
  556. /**
  557. * @api {get} wonderful/main/?l=user.submit_comment 提交评论
  558. * @apiVersion 1.0.0
  559. * @apiName user.submit_comment
  560. * @apiGroup UserAction
  561. *
  562. * @apiDescription 提交评论
  563. *
  564. * @apiParam {String} signature signature
  565. * @apiParam {Number} type type类型
  566. * @apiParam {Number} id 当前的数据id
  567. * @apiParam {String} content 评论内容
  568. *
  569. * @apiSuccess {Number} id 当前的数据id
  570. */
  571. /**
  572. * @api {get} wonderful/main/?l=journal.home 小刊首页
  573. * @apiVersion 1.0.0
  574. * @apiName journal.home
  575. * @apiGroup Journal
  576. *
  577. * @apiDescription 小刊首页
  578. *
  579. * @apiParam {String} signature signature
  580. *
  581. * @apiSuccess {Object[]} journal 小刊数据列表,每页显示10条,请在翻到第7或者第8条时,请求第2页
  582. * @apiSuccess {String} journal.id 小刊id
  583. * @apiSuccess {String} journal.name 名称
  584. * @apiSuccess {String} journal.subname 期号
  585. * @apiSuccess {String} journal.pic_cover 列表封面图片 暂时无效
  586. * @apiSuccess {String} journal.pic_view_cover 小刊封面图片 封面图都用这个
  587. * @apiSuccess {String} journal.pic_view_bg 全屏背景图,多张图片,这是一个数组
  588. * @apiSuccess {String} journal.pdate 时间
  589. * @apiSuccess {String} journal.num_ding 订阅数
  590. * @apiSuccess {String} journal.num_view 浏览量
  591. * @apiSuccess {String} journal.num_comment 评论量
  592. * @apiSuccess {String} journal.buy 小刊是否收费 1收费 2不收费
  593. *
  594. * @apiSuccess {Object[]} subscribe 订阅列表
  595. * @apiSuccess {String} subscribe.id
  596. * @apiSuccess {String} subscribe.username 用户名
  597. * @apiSuccess {String} subscribe.avatar 头像
  598. * @apiSuccess {Object[]} push_jingxuan 精选推荐
  599. * @apiSuccess {String} push_jingxuan.name 名称
  600. * @apiSuccess {String} push_jingxuan.pic 图片
  601. * @apiSuccess {String} push_jingxuan.type 类型,这里为4
  602. * @apiSuccess {String} push_jingxuan.id 源表id,这里是小刊的id
  603. * @apiSuccess {String} push_jingxuan.cdate 时间
  604. * @apiSuccess {Number} push_jingxuan_more 是否显示更多按钮1显示2不显示
  605. */
  606. /**
  607. * @api {get} wonderful/main/?l=journal.read 小刊阅读页
  608. * @apiVersion 1.0.0
  609. * @apiName journal.read
  610. * @apiGroup Journal
  611. *
  612. * @apiDescription 小刊阅读页
  613. *
  614. * @apiParam {String} signature signature
  615. * @apiParam {Number} id 小刊id
  616. *
  617. * @apiSuccess {Object[]} content 内容数据列表,每页显示10条,请在翻到第7或者第8条时,请求第2页
  618. * @apiSuccess {String} content.id 内容id
  619. * @apiSuccess {String} content.type 内容类型1全屏图、2长图、3图文内容、11关联图文、12关联视频、13关联直播
  620. * @apiSuccess {String} content.pic 全屏图或者长图,type=1,2时有效
  621. * @apiSuccess {String} content.is_button 全屏图上的保存按钮,1显示2不显示,type=1时有效
  622. * @apiSuccess {String} content.button_name 全屏图上的保存按钮的文字,type=1时有效
  623. * @apiSuccess {String} content.button_color 全屏图上的保存按钮的文字颜色,type=1时有效
  624. * @apiSuccess {Object[]} content.text 全屏图上的九个文字位置,type=1时有效
  625. * @apiSuccess {String} content.text.text 文字位置,1上左2上中3上右4中左5正中6中右7下左8下中9下右
  626. * @apiSuccess {String} content.text.name 文字内容 换行用\n隔开
  627. * @apiSuccess {String} content.text.color 文字颜色
  628. * @apiSuccess {String} content.text.bgcolor 文字背景颜色
  629. * @apiSuccess {String} content.text.size 文字像素大小
  630. * @apiSuccess {Object[]} content.info type=3,11,12,13时有效,当等于11,12,13时,分别对应图文详情、视频详情、直播详情里的字段,等于3时,请查看以下字段
  631. * @apiSuccess {String} content.info.name 标题
  632. * @apiSuccess {String} content.info.focus 焦点图
  633. * @apiSuccess {String} content.info.content 内容
  634. * @apiSuccess {String} content.info.content_array 数组内容
  635. * @apiSuccess {Object[]} content.info.author 作者
  636. */
  637. /**
  638. * @api {get} wonderful/main/?l=journal.view 小刊详情页
  639. * @apiVersion 1.0.0
  640. * @apiName journal.view
  641. * @apiGroup Journal
  642. *
  643. * @apiDescription 小刊详情页
  644. *
  645. * @apiParam {String} signature signature
  646. * @apiParam {Number} id 小刊id
  647. *
  648. * @apiSuccess {Object[]} info 小刊详情
  649. * @apiSuccess {String} info.id 小刊id
  650. * @apiSuccess {String} info.name 名称
  651. * @apiSuccess {String} journal.subname 期号
  652. * @apiSuccess {String} info.pic_cover 列表封面图片 暂时无效
  653. * @apiSuccess {String} info.pic_view_cover 小刊封面图片 封面图都用这个
  654. * @apiSuccess {String} info.pic_view_bg 全屏背景图,多张图片,这是一个数组
  655. * @apiSuccess {String} info.pdate 时间
  656. * @apiSuccess {String} info.num_ding 订阅数
  657. * @apiSuccess {String} info.num_view 浏览量
  658. * @apiSuccess {String} info.num_comment 评论量
  659. * @apiSuccess {String} info.buy 小刊是否收费 1收费 2不收费
  660. * @apiSuccess {String} info.subscribe 是否订阅,1为已订阅2为未订阅
  661. * @apiSuccess {String} info.active 是否有活动,1为有2为没有,有则显示分享邀请按钮
  662. * @apiSuccess {Object[]} button 按钮判断 如果不需要这个,可以不用
  663. * @apiSuccess {Object[]} button.read 第一个按钮 一般为购买按钮
  664. * @apiSuccess {String} button.read.status 状态 -1不显示 1为进入阅读 2为购买
  665. * @apiSuccess {String} button.read.name 按钮上的名字
  666. * @apiSuccess {Object[]} button.code 第二个按钮 一般为兑换码按钮
  667. * @apiSuccess {String} button.code.status 状态 -1不显示 1为兑换码兑换 2为购买(再次购买)
  668. * @apiSuccess {String} button.code.name 按钮上的名字
  669. * @apiSuccess {Object[]} button.share 第三个按钮 一般为分享邀请按钮
  670. * @apiSuccess {String} button.share.status 状态 -1不显示 1为免费阅读赢取大礼包
  671. * @apiSuccess {String} button.share.name 按钮上的名字
  672. */
  673. /**
  674. * @api {get} wonderful/main/?l=journal.active 小刊活动页
  675. * @apiVersion 1.0.0
  676. * @apiName journal.active
  677. * @apiGroup Journal
  678. *
  679. * @apiDescription 小刊活动页
  680. *
  681. * @apiParam {String} signature signature
  682. * @apiParam {Number} id 小刊id
  683. *
  684. * @apiSuccess {Object[]} info 小刊详情
  685. * @apiSuccess {String} info.id 小刊id
  686. * @apiSuccess {String} info.name 名称
  687. *
  688. * @apiSuccess {Object[]} active 活动说明表
  689. * @apiSuccess {String} active.name 名称
  690. * @apiSuccess {String} active.desc 描述
  691. * @apiSuccess {String} active.buy_title 购买标题
  692. * @apiSuccess {String} active.buy_desc 购买描述
  693. * @apiSuccess {String} active.invite_title 邀请好友标题
  694. * @apiSuccess {String} active.invite_desc 邀请好友描述 换行用\n隔开
  695. * @apiSuccess {String} active.content 活动说明,富文本
  696. */
  697. /**
  698. * @api {get} wonderful/main/?l=journal.buy 小刊购买页
  699. * @apiVersion 1.0.0
  700. * @apiName journal.buy
  701. * @apiGroup Journal
  702. *
  703. * @apiDescription 小刊购买页
  704. *
  705. * @apiParam {String} signature signature
  706. * @apiParam {Number} id 小刊id
  707. *
  708. * @apiSuccess {Object[]} info 小刊详情
  709. * @apiSuccess {String} info.id 小刊id
  710. * @apiSuccess {String} info.name 名称
  711. *
  712. * @apiSuccess {String} buy_desc 购买说明
  713. * @apiSuccess {Object[]} buy_list 购买列表
  714. * @apiSuccess {String} buy_list.id 购买id 支付时使用
  715. * @apiSuccess {String} buy_list.name 名称
  716. * @apiSuccess {String} buy_list.price 标价
  717. * @apiSuccess {String} buy_list.cash 实际支付价格
  718. */
  719. /**
  720. * @api {get} wonderful/main/?l=journal.buy_action 发起微信支付
  721. * @apiVersion 1.0.0
  722. * @apiName journal.buy_action
  723. * @apiGroup Journal
  724. *
  725. * @apiDescription 发起微信支付
  726. *
  727. * @apiParam {String} signature signature
  728. * @apiParam {String} journal_id 小刊id
  729. * @apiParam {String} buy_id 购买本数id
  730. * @apiParam {String} source_signature 分享人的signature,scene参数中的source_signature
  731. *
  732. * @apiSuccess {Object[]} pay 微信支付返回的数据
  733. * @apiSuccess {String} pay.time 服务器时间戳
  734. * @apiSuccess {String} pay.nonce_str 随机字符串
  735. * @apiSuccess {String} pay.prepay_id 统一下单接口返回的 prepay_id 参数值,通过'prepay_id=' + prepay_id 拼装成package
  736. * @apiSuccess {String} pay.sign_type 签名算法
  737. * @apiSuccess {String} pay.sign 签名
  738. */
  739. /**
  740. * @api {get} wonderful/main/?l=journal.code 提交兑换码
  741. * @apiVersion 1.0.0
  742. * @apiName journal.code
  743. * @apiGroup Journal
  744. * @apiDescription 提交兑换码
  745. *
  746. * @apiParam {String} signature signature
  747. * @apiParam {String} journal_id 小刊id
  748. * @apiParam {String} code 兑换码
  749. * @apiParam {String} source_signature 分享人的signature,scene参数中的source_signature
  750. *
  751. * @apiSuccess {String} order_id 兑换成功则返回订单id
  752. */
  753. /**
  754. * @api {get} wonderful/main/?l=journal.checkCode 验证兑换码是否有效
  755. * @apiVersion 1.0.0
  756. * @apiName journal.checkCode
  757. * @apiGroup Journal
  758. *
  759. * @apiDescription 验证兑换码是否有效
  760. *
  761. * @apiParam {String} signature signature
  762. * @apiParam {String} code 兑换码
  763. * @apiSuccess {Object[]} product 小刊信息
  764. * @apiSuccess {String} product.id 小刊id
  765. * @apiSuccess {String} product.name 小刊名称
  766. */
  767. /**
  768. * @api {get} wonderful/main/?l=user.my 获取用户信息
  769. * @apiVersion 1.0.0
  770. * @apiName user.my
  771. * @apiGroup User
  772. *
  773. * @apiDescription 获取用户信息
  774. *
  775. * @apiParam {String} signature signature
  776. *
  777. * @apiSuccess {Object[]} user 用户基本信息
  778. * @apiSuccess {String} user.id 用户id
  779. * @apiSuccess {String} user.username 用户名
  780. * @apiSuccess {String} user.mobile 手机号
  781. * @apiSuccess {String} user.avatar 头像
  782. * @apiSuccess {String} user.level 等级
  783. * @apiSuccess {String} user.score 积分
  784. * @apiSuccess {Number} user_msg 用户新消息数
  785. */
  786. /**
  787. * @api {get} wonderful/main/?l=user.my_msg 获取我的消息
  788. * @apiVersion 1.0.0
  789. * @apiName user.my_msg
  790. * @apiGroup User
  791. *
  792. * @apiDescription 获取我的消息
  793. *
  794. * @apiParam {String} signature signature
  795. *
  796. * @apiSuccess {Object[]} msg 消息列表
  797. * @apiSuccess {String} msg.uid 用户id
  798. * @apiSuccess {String} msg.from_uid 消息来源uid,暂时不用管
  799. * @apiSuccess {String} msg.name 消息标题
  800. * @apiSuccess {String} msg.content 消息内容
  801. * @apiSuccess {String} msg.cdate 时间戳
  802. * @apiSuccess {String} msg.cdate_time 转换成了Y-m-d H:i:s的时间
  803. * @apiSuccess {String} msg.status 消息已读状态1未读2已读
  804. * @apiSuccess {String} msg.type 消息类型,暂时不用管
  805. */
  806. /**
  807. * @api {get} wonderful/main/?l=user.my_up 获取我喜欢的信息
  808. * @apiVersion 1.0.0
  809. * @apiName user.my_up
  810. * @apiGroup User
  811. *
  812. * @apiDescription 获取我喜欢的信息
  813. *
  814. * @apiParam {String} signature signature
  815. *
  816. * @apiSuccess {Object[]} like 用户基本信息
  817. * @apiSuccess {String} like.uid 用户id
  818. * @apiSuccess {String} like.data_id 数据id
  819. * @apiSuccess {String} like.cdate 时间戳
  820. * @apiSuccess {String} like.cdate_time 转换成了Y-m-d H:i:s的时间
  821. * @apiSuccess {String} like.type 类型,参考公共参数中的类型设置说明中的type说明
  822. * @apiSuccess {Object[]} like.info 基本信息 根据type不同,里面的字段有所不同
  823. * @apiSuccess {String} like.info.id 数据id
  824. * @apiSuccess {String} like.info.name 名称
  825. * @apiSuccess {String} like.info.cate_id 栏目ID
  826. * @apiSuccess {String} like.info.cate_name 栏目名称
  827. * @apiSuccess {String} like.info.pic_cover 图片
  828. * @apiSuccess {String} like.info.pdate 发布时间
  829. */
  830. /**
  831. * @api {get} wonderful/main/?l=user.my_comment 获取我评论的信息
  832. * @apiVersion 1.0.0
  833. * @apiName user.my_comment
  834. * @apiGroup User
  835. *
  836. * @apiDescription 获取我喜欢的信息
  837. *
  838. * @apiParam {String} signature signature
  839. *
  840. * @apiSuccess {Object[]} comment 用户基本信息
  841. * @apiSuccess {String} comment.uid 用户id
  842. * @apiSuccess {String} comment.data_id 数据id
  843. * @apiSuccess {String} comment.content 评论内容
  844. * @apiSuccess {String} comment.time 时间:x小时前
  845. * @apiSuccess {String} comment.cdate 时间戳
  846. * @apiSuccess {String} comment.cdate_time 转换成了Y-m-d H:i:s的时间
  847. * @apiSuccess {String} comment.type 类型,参考公共参数中的类型设置说明中的type说明
  848. * @apiSuccess {Object[]} comment.info 基本信息 根据type不同,里面的字段有所不同
  849. * @apiSuccess {String} comment.info.id 数据id
  850. * @apiSuccess {String} comment.info.name 名称
  851. * @apiSuccess {String} comment.info.cate_id 栏目ID
  852. * @apiSuccess {String} comment.info.cate_name 栏目名称
  853. * @apiSuccess {String} comment.info.pic_cover 图片
  854. * @apiSuccess {String} comment.info.pdate 发布时间
  855. */