rabin 5 years ago
parent
commit
1835c9798c
1 changed files with 29 additions and 75 deletions
  1. 29 75
      doc/apidoc.php

+ 29 - 75
doc/apidoc.php

@@ -50,8 +50,8 @@
 */
 
 /**
- * @api {get} mars/passport/?l=applet.login 用户登录
- * @apiVersion 2.0.0
+ * @api {get} mars/package/passport/?l=applet.login 用户登录
+ * @apiVersion 1.0.0
  * @apiName applet.login
  * @apiGroup AppletPassport
  *
@@ -73,7 +73,7 @@
  */
 
 /**
- * @api {get} mars/passport/?l=applet.update 更新用户信息
+ * @api {get} mars/package/passport/?l=applet.update 更新用户信息
  * @apiVersion 1.0.0
  * @apiName applet.update
  * @apiGroup AppletPassport
@@ -100,7 +100,7 @@
 
 
 /**
- * @api {get} mars/passport/?l=applet.mobile 更新用户手机号-微信绑定
+ * @api {get} mars/package/passport/?l=applet.mobile 更新用户手机号-微信绑定
  * @apiVersion 1.0.0
  * @apiName applet.mobile
  * @apiGroup AppletPassport
@@ -120,7 +120,7 @@
  */
 
 /**
- * @api {get} mars/passport/?l=applet.bind_mobile 更新用户手机号-验证码绑定
+ * @api {get} mars/package/passport/?l=applet.bind_mobile 更新用户手机号-验证码绑定
  * @apiVersion 1.0.0
  * @apiName applet.bind_mobile
  * @apiGroup AppletPassport
@@ -138,7 +138,7 @@
  */
 
 /**
- * @api {get} mars/passport/?l=reg.getMCode 获取手机验证码
+ * @api {get} mars/package/passport/?l=reg.getMCode 获取手机验证码
  * @apiVersion 1.0.0
  * @apiName reg.getMCode
  * @apiGroup AppletPassport
@@ -151,7 +151,7 @@
  */
 
 /**
- * @api {get} mars/passport/?l=reg.getMCode 获取手机验证码,未登录状态
+ * @api {get} mars/package/passport/?l=reg.getMCode 获取手机验证码,未登录状态
  * @apiVersion 1.0.0
  * @apiName reg.getMCode
  * @apiGroup AppPassport
@@ -164,7 +164,7 @@
  */
 
 /**
- * @api {get} mars/passport/?l=reg.getMCodeLogin 获取手机验证码,已登录状态
+ * @api {get} mars/package/passport/?l=reg.getMCodeLogin 获取手机验证码,已登录状态
  * @apiVersion 1.0.0
  * @apiName reg.getMCode
  * @apiGroup AppPassport
@@ -178,7 +178,7 @@
  */
 
 /**
- * @api {get} mars/passport/?l=app.login 登录与注册
+ * @api {get} mars/package/passport/?l=app.login 登录与注册
  * @apiVersion 1.0.0
  * @apiName app.login
  * @apiGroup AppPassport
@@ -193,7 +193,7 @@
  */
 
 /**
- * @api {get} mars/passport/?l=app.login_uuid UUID登录
+ * @api {get} mars/package/passport/?l=app.login_uuid UUID登录
  * @apiVersion 1.0.0
  * @apiName app.login_uuid
  * @apiGroup AppPassport
@@ -207,7 +207,7 @@
  */
 
 /**
- * @api {get} mars/passport/?l=app.bind_mobile 更新用户手机号-验证码绑定
+ * @api {get} mars/package/passport/?l=app.bind_mobile 更新用户手机号-验证码绑定
  * @apiVersion 1.0.0
  * @apiName app.bind_mobile
  * @apiGroup AppPassport
@@ -225,7 +225,7 @@
  */
 
 /**
- * @api {get} mars/passport/?l=app.wechat_reg 第三方登录-已经拥有openid
+ * @api {get} mars/package/passport/?l=app.wechat_reg 第三方登录-已经拥有openid
  * @apiVersion 1.0.0
  * @apiName app.wechat_reg
  * @apiGroup AppPassport
@@ -270,7 +270,7 @@
  */
 
 /**
- * @api {get} mars/passport/?l=app.update 更新用户信息
+ * @api {get} mars/package/passport/?l=app.update 更新用户信息
  * @apiVersion 1.0.0
  * @apiName app.update
  * @apiGroup AppPassport
@@ -332,7 +332,7 @@
 
 /**
  * @api {get} mars/main/?l=journal.getList 小程序电子刊列表
- * @apiVersion 2.0.0
+ * @apiVersion 1.0.0
  * @apiName journal.getList
  * @apiGroup Journal
  *
@@ -382,54 +382,8 @@
  */
 
 /**
- * @api {get} mars/main/?l=journal.getAppList APP电子刊列表
- * @apiVersion 2.0.0
- * @apiName journal.getAppList
- * @apiGroup Journal
- *
- * @apiDescription 电子刊列表,按照分类读取,根据获取的信息,可以直接进入到电子刊详情页,无需再次请求接口。
- *
- * @apiParam {String} signature signature
- * @apiParam {String} system 分类id,默认为1,传入-1就是获取全部
- *
- * @apiSuccess {Object[]} journal 电子刊数据列表
- * @apiSuccess {String}   journal.id 电子刊id
- * @apiSuccess {String}   journal.name 名称
- * @apiSuccess {String}   journal.subname 期号
- * @apiSuccess {String}   journal.pic_cover 列表封面图片 暂时无效
- * @apiSuccess {String}   journal.pic_view_cover 电子刊封面图片 封面图都用这个
- * @apiSuccess {String}   journal.pic_view_bg 全屏背景图,多张图片,这是一个数组
- * @apiSuccess {String}   journal.pic_gd 电子刊推广图
- * @apiSuccess {String}   journal.pdate 时间
- * @apiSuccess {String}   journal.num_ding 订阅数
- * @apiSuccess {String}   journal.buy 电子刊是否收费 1收费 2免费
- * @apiSuccess {String}   journal.buy_type 电子刊支付类型,1为普通支付,2为明星支付(读取明星列表)
- * @apiSuccess {String}   journal.bgmusic 电子刊背景音乐
- * @apiSuccess {Object[]}   journal.button 按钮判断 如果不需要这个,可以不用
- * @apiSuccess {Object[]}   journal.button.read 第一个按钮 阅读按钮
- * @apiSuccess {String}   journal.button.read.status 状态 -1不显示 1为进入阅读 2为兑换 3为预售,注意,当值为2时,必须在阅读按钮上,当用户点击按钮时,绑定一个事件,该事件的接口为journal.subscribe
- * @apiSuccess {String}   journal.button.read.name 按钮上的名字
- * @apiSuccess {Object[]}   journal.button.buy 第二个按钮 购买按钮
- * @apiSuccess {String}   journal.button.buy.status 状态 -1不显示 1为购买
- * @apiSuccess {String}   journal.button.buy.name 按钮上的名字
- * @apiSuccess {Object[]}   journal.button.share 第三个按钮 排行榜按钮
- * @apiSuccess {String}   journal.button.share.status 状态 -1不显示 1为排行榜
- * @apiSuccess {String}   journal.button.share.name 按钮上的名字
- *
- * @apiSuccess {Object[]} push 主推电子刊列表 字段参考电子刊数据列表
- *
- * @apiSuccess {Object[]} cate 当前分类
- * @apiSuccess {String}   cate.id 分类id
- * @apiSuccess {String}   cate.name 名称
-
- * @apiSuccess {Object[]} cateList 分类列表
- * @apiSuccess {String}   cateList.id 分类id
- * @apiSuccess {String}   cateList.name 名称
- */
-
-/**
- * @api {get} mars/act/?l=order.getMyList 我的订单列表
- * @apiVersion 2.0.0
+ * @api {get} mars/app/act/?l=order.getMyList 我的订单列表
+ * @apiVersion 1.0.0
  * @apiName order.getMyList
  * @apiGroup UserActionV1
  *
@@ -446,8 +400,8 @@
  */
 
 /**
- * @api {get} mars/act/?l=order.getMyCodeList 我的兑换码列表
- * @apiVersion 2.0.0
+ * @api {get} mars/app/act/?l=order.getMyCodeList 我的兑换码列表
+ * @apiVersion 1.0.0
  * @apiName order.getMyCodeList
  * @apiGroup UserActionV1
  *
@@ -463,7 +417,7 @@
 
 /**
  * @api {get} mars/main/?l=journal.read 电子刊阅读页
- * @apiVersion 2.0.0
+ * @apiVersion 1.0.0
  * @apiName journal.read
  * @apiGroup Journal
  *
@@ -522,7 +476,7 @@
 
 /**
  * @api {get} mars/main/?l=journal.getView 电子刊详情页
- * @apiVersion 2.0.0
+ * @apiVersion 1.0.0
  * @apiName journal.getView
  * @apiGroup Journal
  *
@@ -562,7 +516,7 @@
 
 /**
  * @api {get} mars/main/?l=journal.getAppView APP电子刊详情页
- * @apiVersion 2.0.0
+ * @apiVersion 1.0.0
  * @apiName journal.getAppView
  * @apiGroup Journal
  *
@@ -602,7 +556,7 @@
 
 /**
  * @api {get} mars/main/?l=journal.subscribe 检测电子刊是否可以阅读
- * @apiVersion 2.0.0
+ * @apiVersion 1.0.0
  * @apiName journal.subscribe
  * @apiGroup Journal
  *
@@ -616,7 +570,7 @@
 
 /**
  * @api {get} mars/main/?l=journal.buy 电子刊购买页
- * @apiVersion 2.0.0
+ * @apiVersion 1.0.0
  * @apiName journal.buy
  * @apiGroup Journal
  *
@@ -639,7 +593,7 @@
 
 /**
  * @api {get} mars/main/?l=journal.star 电子刊明星列表页
- * @apiVersion 2.0.0
+ * @apiVersion 1.0.0
  * @apiName journal.star
  * @apiGroup Journal
  *
@@ -659,8 +613,8 @@
  */
 
 /**
- * @api {get} mars/act/?l=order.pay 发起支付
- * @apiVersion 2.0.0
+ * @api {get} mars/app/act/?l=order.pay 发起支付
+ * @apiVersion 1.0.0
  * @apiName order.pay
  * @apiGroup UserActionV1
  *
@@ -683,8 +637,8 @@
  */
 
 /**
- * @api {get} mars/act/?l=order.code 兑换码兑换
- * @apiVersion 2.0.0
+ * @api {get} mars/app/act/?l=order.code 兑换码兑换
+ * @apiVersion 1.0.0
  * @apiName order.code
  * @apiGroup UserActionV1
 
@@ -699,7 +653,7 @@
 
 /**
  * @api {get} mars/main/?l=journal.top 电子刊本数排行榜
- * @apiVersion 2.0.0
+ * @apiVersion 1.0.0
  * @apiName journal.top
  * @apiGroup Journal
  *