|
@@ -1,15 +1,16 @@
|
|
|
<?php
|
|
|
|
|
|
|
|
|
- * @api {get} common 公共参数说明
|
|
|
+ * @api {get} common.public 公共参数说明
|
|
|
* @apiVersion 1.0.0
|
|
|
- * @apiName common
|
|
|
+ * @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 请求的数据是否成功的提示
|
|
@@ -23,6 +24,19 @@
|
|
|
* @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_focus
|
|
|
+ */
|
|
|
+
|
|
|
|
|
|
|
|
|
* @api {get} wonderful/passport/?l=applet.bind 用户登录
|
|
@@ -125,7 +139,13 @@
|
|
|
* @apiParam {String} key 流的key
|
|
|
* @apiParam {String} signature 请将字符串signature_dever_2018_jm经过md5加密
|
|
|
*
|
|
|
- * @apiSuccess {String} live 推流地址
|
|
|
+ * @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 实时截图地址
|
|
|
*/
|
|
|
|
|
|
|
|
@@ -139,33 +159,33 @@
|
|
|
* @apiParam {String} signature signature
|
|
|
*
|
|
|
*
|
|
|
- * @apiSuccess {Number} uid 用户id 所有Service接口中都有该项
|
|
|
- * @apiSuccess {Object[]} config 基本配置 所有Service接口中都有该项
|
|
|
- * @apiSuccess {String} config.name 小程序名称
|
|
|
- * @apiSuccess {String} config.info 小程序介绍
|
|
|
- * @apiSuccess {String} config.edate 产品有效期
|
|
|
- * @apiSuccess {String} config.article 公众号链接-引导关注公众号
|
|
|
- * @apiSuccess {String} config.task_id 软装任务链接-一般填写APPID
|
|
|
- * @apiSuccess {String} config.desc_name 介绍标题-首页服务介绍
|
|
|
- * @apiSuccess {String} config.desc_content 介绍内容-首页服务介绍
|
|
|
- * @apiSuccess {String} config.flow_name 服务流程标题-首页服务流程
|
|
|
- * @apiSuccess {Object[]} config.flow_content 服务流程内容
|
|
|
- * @apiSuccess {String} config.video_content 视频页介绍
|
|
|
- * @apiSuccess {String} config.question_content 问卷介绍
|
|
|
-
|
|
|
- * @apiSuccess {Object[]} focus 焦点图
|
|
|
- * @apiSuccess {String} focus.name 名称
|
|
|
- * @apiSuccess {String} focus.pic 图片
|
|
|
-
|
|
|
- * @apiSuccess {Object[]} product 产品列表
|
|
|
- * @apiSuccess {String} product.id 产品id
|
|
|
- * @apiSuccess {String} product.name 名称
|
|
|
- * @apiSuccess {String} product.info 介绍
|
|
|
- * @apiSuccess {String} product.content 内容
|
|
|
- * @apiSuccess {Object[]} product.price 规格
|
|
|
- * @apiSuccess {String} product.price.price 原价
|
|
|
- * @apiSuccess {String} product.price.zhe_price 折扣价(特价)
|
|
|
- * @apiSuccess {String} product.price.type 获取方式 1为购买,2为兑换,同时出现1,2,两个按钮同时出现
|
|
|
- * @apiSuccess {String} product.price.cash 购买金额,当type=1时有效
|
|
|
- * @apiSuccess {String} product.price.code 兑换码数量,当type=2时有效
|
|
|
+ * @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说明
|
|
|
+
|
|
|
+
|
|
|
*/
|