dever 6 years ago
parent
commit
3bd20b1755
1 changed files with 67 additions and 7 deletions
  1. 67 7
      doc/apidoc.php

+ 67 - 7
doc/apidoc.php

@@ -42,7 +42,7 @@
  * @api {get} wonderful/passport/?l=applet.bind 用户登录
  * @apiVersion 1.0.0
  * @apiName applet.bind
- * @apiGroup Passport
+ * @apiGroup AppletPassport
  *
  * @apiDescription 用户登录
  *
@@ -57,7 +57,7 @@
  * @api {get} wonderful/passport/?l=applet.update 更新用户信息
  * @apiVersion 1.0.0
  * @apiName applet.update
- * @apiGroup Passport
+ * @apiGroup AppletPassport
  *
  * @apiDescription 更新用户信息
  *
@@ -80,7 +80,7 @@
  * @api {get} wonderful/passport/?l=applet.mobile 更新用户手机号-微信绑定
  * @apiVersion 1.0.0
  * @apiName applet.mobile
- * @apiGroup Passport
+ * @apiGroup AppletPassport
  *
  * @apiDescription 更新用户手机号-微信绑定
  *
@@ -97,12 +97,12 @@
  */
 
 /**
- * @api {get} wonderful/passport/?l=applet.bind_mobile 绑定手机号-验证码绑定
+ * @api {get} wonderful/passport/?l=applet.bind_mobile 更新用户手机号-验证码绑定
  * @apiVersion 1.0.0
  * @apiName applet.bind_mobile
- * @apiGroup Passport
+ * @apiGroup AppletPassport
  *
- * @apiDescription 绑定手机号-验证码绑定
+ * @apiDescription 更新用户手机号-验证码绑定
  *
  * @apiParam {Number} uid 用户id
  * @apiParam {Number} mobile 手机号
@@ -118,16 +118,76 @@
  * @api {get} wonderful/passport/?l=reg.getMCode 获取手机验证码
  * @apiVersion 1.0.0
  * @apiName reg.getMCode
- * @apiGroup Passport
+ * @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/main/?l=live.get 获取直播推流信息