diff --git a/application/api/controller/Common.php b/application/api/controller/Common.php index 6ffd1a5a70da213ae3d78a59f3227760658084f2..4113a7d77404f981b8277f6754b6f163d74829d9 100644 --- a/application/api/controller/Common.php +++ b/application/api/controller/Common.php @@ -38,9 +38,9 @@ class Common extends Api /** * 加载初始化 * - * @param string $version 版本号 - * @param string $lng 经度 - * @param string $lat 纬度 + * @ApiParams (name="version", type="string", required=true, description="版本号") + * @ApiParams (name="lng", type="string", required=true, description="经度") + * @ApiParams (name="lat", type="string", required=true, description="纬度") */ public function init() { @@ -80,7 +80,7 @@ class Common extends Api /** * 上传文件 * @ApiMethod (POST) - * @param File $file 文件流 + * @ApiParams (name="file", type="File", required=true, description="文件流") */ public function upload() { @@ -148,7 +148,7 @@ class Common extends Api /** * 验证码 - * @param $id + * @ApiParams (name="id", type="string", required=true, description="要生成验证码的标识") * @return \think\Response */ public function captcha($id = "") diff --git a/application/api/controller/Ems.php b/application/api/controller/Ems.php index 68f336cf4321800f1a07603198839f71bd915cd7..01123ebb5f8535c22162654e480f8d1279568153 100644 --- a/application/api/controller/Ems.php +++ b/application/api/controller/Ems.php @@ -24,8 +24,8 @@ class Ems extends Api * 发送验证码 * * @ApiMethod (POST) - * @param string $email 邮箱 - * @param string $event 事件名称 + * @ApiParams (name="email", type="string", required=true, description="邮箱") + * @ApiParams (name="event", type="string", required=true, description="事件名称") */ public function send() { @@ -68,9 +68,9 @@ class Ems extends Api * 检测验证码 * * @ApiMethod (POST) - * @param string $email 邮箱 - * @param string $event 事件名称 - * @param string $captcha 验证码 + * @ApiParams (name="email", type="string", required=true, description="邮箱") + * @ApiParams (name="event", type="string", required=true, description="事件名称") + * @ApiParams (name="captcha", type="string", required=true, description="验证码") */ public function check() { diff --git a/application/api/controller/Sms.php b/application/api/controller/Sms.php index 373b1299cde25e2a2305f11d2017320aa298e74f..a5010cb48c58a1cd8067d9f54e6abf94f4832748 100644 --- a/application/api/controller/Sms.php +++ b/application/api/controller/Sms.php @@ -19,8 +19,8 @@ class Sms extends Api * 发送验证码 * * @ApiMethod (POST) - * @param string $mobile 手机号 - * @param string $event 事件名称 + * @ApiParams (name="mobile", type="string", required=true, description="手机号") + * @ApiParams (name="event", type="string", required=true, description="事件名称") */ public function send() { @@ -67,9 +67,9 @@ class Sms extends Api * 检测验证码 * * @ApiMethod (POST) - * @param string $mobile 手机号 - * @param string $event 事件名称 - * @param string $captcha 验证码 + * @ApiParams (name="mobile", type="string", required=true, description="手机号") + * @ApiParams (name="event", type="string", required=true, description="事件名称") + * @ApiParams (name="captcha", type="string", required=true, description="验证码") */ public function check() { diff --git a/application/api/controller/User.php b/application/api/controller/User.php index d77a67adecf8bb1aa85e35bb317ca71c42470994..d269016793406d50b6f97e573b75976a0693db9d 100644 --- a/application/api/controller/User.php +++ b/application/api/controller/User.php @@ -39,8 +39,8 @@ class User extends Api * 会员登录 * * @ApiMethod (POST) - * @param string $account 账号 - * @param string $password 密码 + * @ApiParams (name="account", type="string", required=true, description="账号") + * @ApiParams (name="password", type="string", required=true, description="密码") */ public function login() { @@ -62,8 +62,8 @@ class User extends Api * 手机验证码登录 * * @ApiMethod (POST) - * @param string $mobile 手机号 - * @param string $captcha 验证码 + * @ApiParams (name="mobile", type="string", required=true, description="手机号") + * @ApiParams (name="captcha", type="string", required=true, description="验证码") */ public function mobilelogin() { @@ -101,11 +101,11 @@ class User extends Api * 注册会员 * * @ApiMethod (POST) - * @param string $username 用户名 - * @param string $password 密码 - * @param string $email 邮箱 - * @param string $mobile 手机号 - * @param string $code 验证码 + * @ApiParams (name="username", type="string", required=true, description="用户名") + * @ApiParams (name="password", type="string", required=true, description="密码") + * @ApiParams (name="email", type="string", required=true, description="邮箱") + * @ApiParams (name="mobile", type="string", required=true, description="手机号") + * @ApiParams (name="code", type="string", required=true, description="验证码") */ public function register() { @@ -153,10 +153,10 @@ class User extends Api * 修改会员个人信息 * * @ApiMethod (POST) - * @param string $avatar 头像地址 - * @param string $username 用户名 - * @param string $nickname 昵称 - * @param string $bio 个人简介 + * @ApiParams (name="avatar", type="string", required=true, description="头像地址") + * @ApiParams (name="username", type="string", required=true, description="用户名") + * @ApiParams (name="nickname", type="string", required=true, description="昵称") + * @ApiParams (name="bio", type="string", required=true, description="个人简介") */ public function profile() { @@ -189,8 +189,8 @@ class User extends Api * 修改邮箱 * * @ApiMethod (POST) - * @param string $email 邮箱 - * @param string $captcha 验证码 + * @ApiParams (name="email", type="string", required=true, description="邮箱") + * @ApiParams (name="captcha", type="string", required=true, description="验证码") */ public function changeemail() { @@ -224,8 +224,8 @@ class User extends Api * 修改手机号 * * @ApiMethod (POST) - * @param string $mobile 手机号 - * @param string $captcha 验证码 + * @ApiParams (name="mobile", type="string", required=true, description="手机号") + * @ApiParams (name="captcha", type="string", required=true, description="验证码") */ public function changemobile() { @@ -259,8 +259,8 @@ class User extends Api * 第三方登录 * * @ApiMethod (POST) - * @param string $platform 平台名称 - * @param string $code Code码 + * @ApiParams (name="platform", type="string", required=true, description="平台名称") + * @ApiParams (name="code", type="string", required=true, description="Code码") */ public function third() { @@ -291,9 +291,9 @@ class User extends Api * 重置密码 * * @ApiMethod (POST) - * @param string $mobile 手机号 - * @param string $newpassword 新密码 - * @param string $captcha 验证码 + * @ApiParams (name="mobile", type="string", required=true, description="手机号") + * @ApiParams (name="newpassword", type="string", required=true, description="新密码") + * @ApiParams (name="captcha", type="string", required=true, description="验证码") */ public function resetpwd() { diff --git a/application/api/controller/Validate.php b/application/api/controller/Validate.php index adb36d0ffbcf4d7a81c598d3505d412c2c03d8cf..6538f8d84399ae0e337dd7deb6e60b8fda301048 100644 --- a/application/api/controller/Validate.php +++ b/application/api/controller/Validate.php @@ -23,8 +23,8 @@ class Validate extends Api * 检测邮箱 * * @ApiMethod (POST) - * @param string $email 邮箱 - * @param string $id 排除会员ID + * @ApiParams (name="email", type="string", required=true, description="邮箱") + * @ApiParams (name="id", type="string", required=true, description="排除会员ID") */ public function check_email_available() { @@ -41,8 +41,8 @@ class Validate extends Api * 检测用户名 * * @ApiMethod (POST) - * @param string $username 用户名 - * @param string $id 排除会员ID + * @ApiParams (name="username", type="string", required=true, description="用户名") + * @ApiParams (name="id", type="string", required=true, description="排除会员ID") */ public function check_username_available() { @@ -59,8 +59,8 @@ class Validate extends Api * 检测昵称 * * @ApiMethod (POST) - * @param string $nickname 昵称 - * @param string $id 排除会员ID + * @ApiParams (name="nickname", type="string", required=true, description="昵称") + * @ApiParams (name="id", type="string", required=true, description="排除会员ID") */ public function check_nickname_available() { @@ -77,8 +77,8 @@ class Validate extends Api * 检测手机 * * @ApiMethod (POST) - * @param string $mobile 手机号 - * @param string $id 排除会员ID + * @ApiParams (name="mobile", type="string", required=true, description="手机号") + * @ApiParams (name="id", type="string", required=true, description="排除会员ID") */ public function check_mobile_available() { @@ -95,7 +95,7 @@ class Validate extends Api * 检测手机 * * @ApiMethod (POST) - * @param string $mobile 手机号 + * @ApiParams (name="mobile", type="string", required=true, description="手机号") */ public function check_mobile_exist() { @@ -111,7 +111,7 @@ class Validate extends Api * 检测邮箱 * * @ApiMethod (POST) - * @param string $mobile 邮箱 + * @ApiParams (name="email", type="string", required=true, description="邮箱") */ public function check_email_exist() { @@ -127,9 +127,9 @@ class Validate extends Api * 检测手机验证码 * * @ApiMethod (POST) - * @param string $mobile 手机号 - * @param string $captcha 验证码 - * @param string $event 事件 + * @ApiParams (name="mobile", type="string", required=true, description="手机号") + * @ApiParams (name="captcha", type="string", required=true, description="验证码") + * @ApiParams (name="event", type="string", required=true, description="事件") */ public function check_sms_correct() { @@ -146,9 +146,9 @@ class Validate extends Api * 检测邮箱验证码 * * @ApiMethod (POST) - * @param string $email 邮箱 - * @param string $captcha 验证码 - * @param string $event 事件 + * @ApiParams (name="email", type="string", required=true, description="邮箱") + * @ApiParams (name="captcha", type="string", required=true, description="验证码") + * @ApiParams (name="event", type="string", required=true, description="事件") */ public function check_ems_correct() {