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 Passport
 *
 * @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 Passport
 *
 * @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 Passport
 *
 * @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 Passport
 *
 * @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 Passport
 *
 * @apiDescription 获取手机验证码
 *
 * @apiParam {Number} mobile 手机号
 * @apiParam {String} signature signature
 *
 * @apiSuccess {String}   msg 验证码已发送至您的手机，请注意查收，十分钟之内有效
 */

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

/**
 * @api {get} wonderful/main/?l=content.home 获取首页数据
 * @apiVersion 1.0.0
 * @apiName api.home
 * @apiGroup Content
 *
 * @apiDescription 获取首页数据
 *
 * @apiParam {String} signature signature
 *
 *
 * @apiSuccess {Number}   uid  用户id 所有接口中都有该项
 * @apiSuccess {Object[]} config 基本配置 所有接口中都有该项
 * @apiSuccess {String}   config.name 系统名称
 * @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 图片
 * @apiSuccess {String}   news.type 类型，参考公共参数中的类型设置说明中的type说明


 */