wonderful/doc/apidoc.php

<?php 

/**
 * @api {get} common.public 公共参数说明
 * @apiVersion 1.0.0
 * @apiName common.public
 * @apiGroup Common
 *
 * @apiDescription 介绍公共参数
 *
 * @apiParam {Number} json 是否返回json格式的数据1为返回2为不返回
 * @apiParam {Number} signature 用于登录后的uid验证，每次都要传入，请登录后将这个值保存在本地
 * @apiParam {Number} pg 分页数，第几页，列表页瀑布流使用该参数
 *
 * @apiSuccess {Number}   status  状态，1为有效2为无效
 * @apiSuccess {String}   msg 请求的数据是否成功的提示
 * @apiSuccess {String}   data 如果status为1,data有值
 * @apiSuccess {Object[]}   page 分页信息
 * @apiSuccess {Number}   page.total 分页总数
 * @apiSuccess {Number}   page.current_page 当前页
 * @apiSuccess {Number}   page.total_page 总页数
 * @apiSuccess {Number}   page.next_page 下一页
 * @apiSuccess {Number}   page.prev_page 上一页
 * @apiSuccess {Number}   page.status 是否有下一页数据，0为没有
 */

/**
 * @api {get} common.type 类型设置说明
 * @apiVersion 1.0.0
 * @apiName common.type
 * @apiGroup Common
 *
 * @apiDescription 类型设置说明
 *
 * @apiParam {String} source_type 请在header中定义，ios：ios | android：android | 移动h5：h5  | 小程序：applet | 公众号：service | pc网站：pc
 * @apiParam {Number} type 图文：1 | 视频：2 | 直播：3 | 小刊：4 | 链接：10
 * @apiParam {Number} push_ 所有带push_开头的返回参数，返回字典都是一样的，参考获取首页数据中的push_focus
 */


/**
 * @api {get} wonderful/passport/?l=applet.bind 用户登录
 * @apiVersion 1.0.0
 * @apiName applet.bind
 * @apiGroup AppletPassport
 *
 * @apiDescription 用户登录
 *
 * @apiParam {String} code 微信登录返回的code
 *
 * @apiSuccess {Number}   vid  微信id，请保存在本地
 * @apiSuccess {Number}   uid  用户id，请保存在本地
 * @apiSuccess {String}   signature 用于登录后的uid验证，每次都要传入，请登录后将这个值保存在本地
 */

/**
 * @api {get} wonderful/passport/?l=applet.update 更新用户信息
 * @apiVersion 1.0.0
 * @apiName applet.update
 * @apiGroup AppletPassport
 *
 * @apiDescription 更新用户信息
 *
 * @apiParam {String} nickname 用户昵称
 * @apiParam {String} avatarurl 用户头像
 * @apiParam {String} iv 微信的加密参数
 * @apiParam {String} encryptedData 微信的加密参数
 * @apiParam {Number} vid 微信id
 * @apiParam {Number} uid 用户id
 * @apiParam {String} signature signature
 *
 *
 * @apiSuccess {Number}   vid  微信id，请保存在本地
 * @apiSuccess {Number}   uid  用户id，请保存在本地
 * @apiSuccess {String}   signature 用于登录后的uid验证，每次都要传入，请登录后将这个值保存在本地
 */


/**
 * @api {get} wonderful/passport/?l=applet.mobile 更新用户手机号-微信绑定
 * @apiVersion 1.0.0
 * @apiName applet.mobile
 * @apiGroup AppletPassport
 *
 * @apiDescription 更新用户手机号-微信绑定
 *
 * @apiParam {String} iv 微信的加密参数
 * @apiParam {String} encryptedData 微信的加密参数
 * @apiParam {Number} vid 微信id
 * @apiParam {Number} uid 用户id
 * @apiParam {String} signature signature
 *
 *
 * @apiSuccess {Number}   vid  微信id，请保存在本地
 * @apiSuccess {Number}   uid  用户id，请保存在本地
 * @apiSuccess {String}   signature 用于登录后的uid验证，每次都要传入，请登录后将这个值保存在本地
 */

/**
 * @api {get} wonderful/passport/?l=applet.bind_mobile 更新用户手机号-验证码绑定
 * @apiVersion 1.0.0
 * @apiName applet.bind_mobile
 * @apiGroup AppletPassport
 *
 * @apiDescription 更新用户手机号-验证码绑定
 *
 * @apiParam {Number} uid 用户id
 * @apiParam {Number} mobile 手机号
 * @apiParam {String} mcode 验证码
 * @apiParam {String} signature signature
 *

 * @apiSuccess {Number}   uid  用户id，请保存在本地
 * @apiSuccess {String}   signature 用于登录后的uid验证，每次都要传入，请登录后将这个值保存在本地
 */

/**
 * @api {get} wonderful/passport/?l=reg.getMCode 获取手机验证码
 * @apiVersion 1.0.0
 * @apiName reg.getMCode
 * @apiGroup AppletPassport
 *
 * @apiDescription 获取手机验证码
 *
 * @apiParam {Number} mobile 手机号
 *
 * @apiSuccess {String}   msg 验证码已发送至您的手机，请注意查收，十分钟之内有效
 */

/**
 * @api {get} wonderful/passport/?l=reg.getMCode 获取手机验证码，未登录状态
 * @apiVersion 1.0.0
 * @apiName reg.getMCode
 * @apiGroup AppPassport
 *
 * @apiDescription 获取手机验证码，未登录状态
 *
 * @apiParam {Number} mobile 手机号
 *
 * @apiSuccess {String}   msg 验证码已发送至您的手机，请注意查收，十分钟之内有效
 */

/**
 * @api {get} wonderful/passport/?l=reg.getMCodeLogin 获取手机验证码，已登录状态
 * @apiVersion 1.0.0
 * @apiName reg.getMCode
 * @apiGroup AppPassport
 *
 * @apiDescription 获取手机验证码，已登录状态
 *
 * @apiParam {Number} mobile 手机号
 * @apiParam {String} signature signature
 *
 * @apiSuccess {String}   msg 验证码已发送至您的手机，请注意查收，十分钟之内有效
 */

/**
 * @api {get} wonderful/passport/?l=app.login 登录与注册
 * @apiVersion 1.0.0
 * @apiName app.login
 * @apiGroup AppPassport
 *
 * @apiDescription 登录与注册
 *
 * @apiParam {Number} mobile 手机号
 * @apiParam {String} code 验证码
 *
 * @apiSuccess {Number}   uid  用户id，请保存在本地
 * @apiSuccess {String}   signature 用于登录后的uid验证，每次都要传入，请登录后将这个值保存在本地
 */

/**
 * @api {get} wonderful/passport/?l=app.update 更新用户信息
 * @apiVersion 1.0.0
 * @apiName app.update
 * @apiGroup AppPassport
 *
 * @apiDescription 更新用户信息
 *
 * @apiParam {Number} signature 用户signature
 * @apiParam {String} avatar 头像
 * @apiParam {String} gender 性别
 * @apiParam {String} city 城市
 * @apiParam {String} province 省份
 * @apiParam {String} country 县区
 *
 * @apiSuccess {Number}   uid  用户id，请保存在本地
 * @apiSuccess {String}   signature 用于登录后的uid验证，每次都要传入，请登录后将这个值保存在本地
 */


/**
 * @api {get} wonderful/live/?l=api.get 获取直播推流信息
 * @apiVersion 1.0.0
 * @apiName api.get
 * @apiGroup Live
 *
 * @apiDescription 获取直播推流信息
 *
 * @apiParam {String} signature 请将字符串signature_dever_2018_jm经过md5加密
 *
 * @apiSuccess {Object[]} active 直播活动列表
 * @apiSuccess {String}   active.id 活动id
 * @apiSuccess {String}   acitve.name 活动名称
 * @apiSuccess {Object[]} active.stream 直播流列表
 * @apiSuccess {String}   active.stream.id 推流id
 * @apiSuccess {String}   active.stream.live 推流实际地址
 * @apiSuccess {String}   active.stream.url_rtmp 播放地址
 * @apiSuccess {String}   active.stream.url_hls 播放地址
 * @apiSuccess {String}   active.stream.url_hdl 播放地址
 * @apiSuccess {String}   active.stream.url_pic 实时截图地址
 */

/**
 * @api {get} wonderful/live/?l=api.start 开始推流
 * @apiVersion 1.0.0
 * @apiName api.start
 * @apiGroup Live
 *
 * @apiDescription 开始推流
 *
 * @apiParam {String} signature 请将字符串signature_dever_2018_jm经过md5加密
 * @apiParam {Number} id 推流id
 *
 * @apiSuccess {Number}   id 推流id
 * @apiSuccess {Number}   log_id 本次推流日志id
 */

/**
 * @api {get} wonderful/live/?l=api.stop 结束推流
 * @apiVersion 1.0.0
 * @apiName api.stop
 * @apiGroup Live
 *
 * @apiDescription 结束推流 一定要调用该接口，否则不会生成回放地址
 *
 * @apiParam {String} signature 请将字符串signature_dever_2018_jm经过md5加密
 * @apiParam {Number} id 推流id
 * @apiParam {Number} log_id 本次推流日志id
 */


/**
 * @api {get} wonderful/main/?l=content.home 获取首页数据
 * @apiVersion 1.0.0
 * @apiName content.home
 * @apiGroup Content
 *
 * @apiDescription 获取首页数据
 *
 * @apiParam {String} signature signature
 *
 *
 * @apiSuccess {Number}   uid  用户id 所有接口中都有该项
 * @apiSuccess {Object[]} config 基本配置 所有接口中都有该项
 * @apiSuccess {String}   config.name 系统名称 请将小程序和app头部名称替换为该字段
 * @apiSuccess {String}   config.info 系统介绍
 * @apiSuccess {String}   config.logo 系统logo

 * @apiSuccess {Object[]} push_menu 栏目
 * @apiSuccess {String}   push_menu.name 名称
 * @apiSuccess {String}   push_menu.pic 图片
 * @apiSuccess {String}   push_menu.type 类型，参考公共参数中的类型设置说明中的type说明
 * @apiSuccess {String}   push_menu.id 源表id，根据type计算路径，然后把这个source_id加上就是最终的path，小程序和app同样。
 * @apiSuccess {String}   push_menu.link 当type==10时有效，链接
 * @apiSuccess {String}   push_menu.cdate 时间

 * @apiSuccess {Object[]} push_focus 焦点图，字段同上

 * @apiSuccess {Object[]} push_link 栏目，字段同上

 * @apiSuccess {Object[]} push_ad 栏目，字段同上

 * @apiSuccess {Object[]} push_up 栏目，字段同上

 * @apiSuccess {Object[]} news 更多图文等数据
 * @apiSuccess {String}   news.id 图文id
 * @apiSuccess {String}   news.name 名称
 * @apiSuccess {String}   news.pic_cover 图片
 * @apiSuccess {String}   news.type 类型，参考公共参数中的类型设置说明中的type说明，根据它生成path
 * @apiSuccess {String}   news.pdate 时间
 * @apiSuccess {String}   news.num_view 浏览量
 * @apiSuccess {String}   news.num_up 点赞量
 * @apiSuccess {String}   news.num_comment 评论量
 * @apiSuccess {String}   news.num_ding 订阅量
 * @apiSuccess {String}   news.num_user 在线人数
 * @apiSuccess {String}   news.share_yes 是否显示分享按钮 1显示 2不显示
 * @apiSuccess {String}   news.share_title 分享标题
 * @apiSuccess {String}   news.share_pic 分享图片
 * @apiSuccess {String}   news.share_content 分享内容

 */


/**
 * @api {get} wonderful/main/?l=content.up 精选推荐更多
 * @apiVersion 1.0.0
 * @apiName content.up
 * @apiGroup Content
 *
 * @apiDescription 精选推荐更多
 *
 * @apiParam {String} signature signature
 *
 *
 * @apiSuccess {Object[]} push_up 栏目，字段同上
 * @apiSuccess {String}   push_up.name 名称
 * @apiSuccess {String}   push_up.pic 图片
 * @apiSuccess {String}   push_up.type 类型，参考公共参数中的类型设置说明中的type说明
 * @apiSuccess {String}   push_up.id 源表id，根据type计算路径，然后把这个source_id加上就是最终的path，小程序和app同样。
 * @apiSuccess {String}   push_up.link 当type==10时有效，链接
 * @apiSuccess {String}   push_up.cdate 时间

 */


/**
 * @api {get} wonderful/main/?l=content.news 精选页图文内容下拉更多
 * @apiVersion 1.0.0
 * @apiName content.news
 * @apiGroup Content
 *
 * @apiDescription 精选页图文内容下拉更多
 *
 * @apiParam {String} signature signature
 *
 * @apiSuccess {Object[]} news 更多图文等数据
 * @apiSuccess {String}   news.id 图文id
 * @apiSuccess {String}   news.name 名称
 * @apiSuccess {String}   news.pic_cover 图片
 * @apiSuccess {String}   news.type 类型，参考公共参数中的类型设置说明中的type说明，根据它生成path
 * @apiSuccess {String}   news.pdate 时间
 * @apiSuccess {String}   news.num_view 浏览量
 * @apiSuccess {String}   news.num_up 点赞量
 * @apiSuccess {String}   news.num_comment 评论量
 * @apiSuccess {String}   news.num_ding 订阅量
 * @apiSuccess {String}   news.num_user 在线人数
 * @apiSuccess {String}   news.share_yes 是否显示分享按钮 1显示 2不显示
 * @apiSuccess {String}   news.share_title 分享标题
 * @apiSuccess {String}   news.share_pic 分享图片
 * @apiSuccess {String}   news.share_content 分享内容
 */

/**
 * @api {get} wonderful/main/?l=view.comment 查看评论列表
 * @apiVersion 1.0.0
 * @apiName view.comment
 * @apiGroup Content
 *
 * @apiDescription 查看评论列表
 *
 * @apiParam {String} signature signature
 * @apiParam {Number} id 图文id
 * @apiParam {Number} type 类型，参考公共参数中的类型设置说明中的type说明
 *
 * @apiSuccess {Object[]} comment 评论列表
 * @apiSuccess {String}   comment.id 
 * @apiSuccess {String}   comment.username 用户名
 * @apiSuccess {String}   comment.avatar 头像
 * @apiSuccess {String}   comment.content 内容
 * @apiSuccess {String}   comment.cdate 时间
 */

/**
 * @api {get} wonderful/main/?l=view.article 查看图文内容
 * @apiVersion 1.0.0
 * @apiName view.article
 * @apiGroup Content
 *
 * @apiDescription 查看图文内容
 *
 * @apiParam {String} signature signature
 * @apiParam {Number} id 图文id
 *
 * @apiSuccess {Object[]} info 图文数据
 * @apiSuccess {String}   info.id 
 * @apiSuccess {String}   info.name 名称
 * @apiSuccess {String}   info.pic_cover 图片
 * @apiSuccess {String}   info.type 类型，参考公共参数中的类型设置说明中的type说明，根据它生成path
 * @apiSuccess {String}   info.pdate 时间
 * @apiSuccess {String}   info.num_view 浏览量
 * @apiSuccess {String}   info.num_up 点赞量
 * @apiSuccess {String}   info.num_comment 评论量
 * @apiSuccess {String}   info.share_yes 是否显示分享按钮 1显示 2不显示
 * @apiSuccess {String}   info.share_title 分享标题
 * @apiSuccess {String}   info.share_pic 分享图片
 * @apiSuccess {String}   info.share_content 分享内容
 * @apiSuccess {String}   info.function 开启的功能，这是一个字符串，用逗号隔开的，1代表显示浏览量，2代表显示评论，3代表显示喜欢，4代表显示邀请阅读，如值为1,2,3，则显示浏览量、评论、喜欢，不显示邀请阅读
 * @apiSuccess {String}   info.content 内容
 * @apiSuccess {String}   info.content_array 数组内容，请使用该字段循环
 *
 * @apiSuccess {Object[]} comment 评论列表
 * @apiSuccess {String}   comment.id 
 * @apiSuccess {String}   comment.username 用户名
 * @apiSuccess {String}   comment.avatar 头像
 * @apiSuccess {String}   comment.content 内容
 * @apiSuccess {String}   comment.cdate 时间

 *
 * @apiSuccess {Object[]} user_act 用户行为 当用户登录时有效
 * @apiSuccess {String}   user_act.share 用户分享数 
 * @apiSuccess {String}   user_act.up 是否点赞1为点赞，2为未点赞
 */

/**
 * @api {get} wonderful/main/?l=view.vod 查看视频内容
 * @apiVersion 1.0.0
 * @apiName view.vod
 * @apiGroup Content
 *
 * @apiDescription 查看视频内容
 *
 * @apiParam {String} signature signature
 * @apiParam {Number} id 视频id
 *
 * @apiSuccess {Object[]} info 视频数据
 * @apiSuccess {String}   info.id 
 * @apiSuccess {String}   info.name 名称
 * @apiSuccess {String}   info.pic_cover 图片
 * @apiSuccess {String}   info.type 类型，参考公共参数中的类型设置说明中的type说明，根据它生成path
 * @apiSuccess {String}   info.pdate 时间
 * @apiSuccess {String}   info.num_view 浏览量
 * @apiSuccess {String}   info.num_up 点赞量
 * @apiSuccess {String}   info.num_comment 评论量
 * @apiSuccess {String}   info.share_yes 是否显示分享按钮 1显示 2不显示
 * @apiSuccess {String}   info.share_title 分享标题
 * @apiSuccess {String}   info.share_pic 分享图片
 * @apiSuccess {String}   info.share_content 分享内容
 * @apiSuccess {String}   info.function 开启的功能，这是一个字符串，用逗号隔开的，1代表显示浏览量，2代表显示评论，3代表显示喜欢，4代表显示邀请阅读，如值为1,2,3，则显示浏览量、评论、喜欢，不显示邀请阅读
 * @apiSuccess {String}   info.content 内容
 *
 *
 * @apiSuccess {Object[]} comment 评论列表
 * @apiSuccess {String}   comment.id 
 * @apiSuccess {String}   comment.username 用户名
 * @apiSuccess {String}   comment.avatar 头像
 * @apiSuccess {String}   comment.content 内容
 * @apiSuccess {String}   comment.cdate 时间

 *
 * @apiSuccess {Object[]} user_act 用户行为 当用户登录时有效
 * @apiSuccess {String}   user_act.share 用户分享数 
 * @apiSuccess {String}   user_act.up 是否点赞1为点赞，2为未点赞
 */

/**
 * @api {get} wonderful/main/?l=view.live 查看直播内容
 * @apiVersion 1.0.0
 * @apiName view.live
 * @apiGroup Content
 *
 * @apiDescription 查看直播内容
 *
 * @apiParam {String} signature signature
 * @apiParam {Number} id 视频id
 *
 * @apiSuccess {Object[]} info 直播数据
 * @apiSuccess {String}   info.id 
 * @apiSuccess {String}   info.name 名称
 * @apiSuccess {String}   info.pic_cover 图片
 * @apiSuccess {String}   info.type 类型，参考公共参数中的类型设置说明中的type说明，根据它生成path
 * @apiSuccess {String}   info.pdate 时间
 * @apiSuccess {String}   info.num_view 浏览量
 * @apiSuccess {String}   info.num_up 点赞量
 * @apiSuccess {String}   info.num_comment 评论量
 * @apiSuccess {String}   info.share_yes 是否显示分享按钮 1显示 2不显示
 * @apiSuccess {String}   info.share_title 分享标题
 * @apiSuccess {String}   info.share_pic 分享图片
 * @apiSuccess {String}   info.share_content 分享内容
 * @apiSuccess {String}   info.function 开启的功能，这是一个字符串，用逗号隔开的，1代表显示浏览量，2代表显示评论，3代表显示喜欢，4代表显示邀请阅读，如值为1,2,3，则显示浏览量、评论、喜欢，不显示邀请阅读
 * @apiSuccess {String}   info.content 内容
 *
 *
 * @apiSuccess {Object[]} comment 评论列表
 * @apiSuccess {String}   comment.id 
 * @apiSuccess {String}   comment.username 用户名
 * @apiSuccess {String}   comment.avatar 头像
 * @apiSuccess {String}   comment.content 内容
 * @apiSuccess {String}   comment.cdate 时间

 *
 * @apiSuccess {Object[]} user_act 用户行为 当用户登录时有效
 * @apiSuccess {String}   user_act.share 用户分享数 
 * @apiSuccess {String}   user_act.up 是否点赞1为点赞，2为未点赞
 */


/**
 * @api {get} wonderful/main/?l=user.submit_up 点赞
 * @apiVersion 1.0.0
 * @apiName user.submit_up
 * @apiGroup UserAction
 *
 * @apiDescription 点赞
 *
 * @apiParam {String} signature signature
 * @apiParam {Number} type type类型
 * @apiParam {Number} id 当前的数据id
 *
 * @apiSuccess {Number}  id 当前的数据id
 */

/**
 * @api {get} wonderful/main/?l=user.submit_share 分享
 * @apiVersion 1.0.0
 * @apiName user.submit_share
 * @apiGroup UserAction
 *
 * @apiDescription 分享
 *
 * @apiParam {String} signature signature
 * @apiParam {Number} type type类型
 * @apiParam {Number} id 当前的数据id
 * @apiParam {String} desc 说明：这是分享的说明介绍，请不要传入该参数，底层页分享时，请把路径path设置为首页的path?scene=signature,type,id  signature：当前邀请者的signature | type：当前分享的类型 图文等 | id：当前分享的图文的id，小程序中请判断，如果首页有scene参数，请在正常请求首页数据之后，先发起分享回流接口的请求，然后根据scene参数中的type和id的值，跳转到type所对应的path的详情页即可。
 *
 * @apiSuccess {Number}  id 当前的数据id
 */

/**
 * @api {get} wonderful/main/?l=user.submit_share_reflux 分享回流
 * @apiVersion 1.0.0
 * @apiName user.submit_share_reflux
 * @apiGroup UserAction
 *
 * @apiDescription 分享回流
 *
 * @apiParam {String} signature signature
 * @apiParam {Number} type type类型 scene参数中的第二个值
 * @apiParam {Number} id 当前的数据id scene参数中的第三个值
 * @apiParam {String} source_signature 回流的源用户id，scene参数中的第一个值
 *
 * @apiSuccess {Number}  id 当前的数据id
 */

/**
 * @api {get} wonderful/main/?l=user.submit_comment 提交评论
 * @apiVersion 1.0.0
 * @apiName user.submit_comment
 * @apiGroup UserAction
 *
 * @apiDescription 提交评论
 *
 * @apiParam {String} signature signature
 * @apiParam {Number} type type类型
 * @apiParam {Number} id 当前的数据id
 * @apiParam {String} content 评论内容
 *
 * @apiSuccess {Number}  id 当前的数据id
 */