hitsword
/
fastadmin
mirror of https://gitee.com/karson/fastadmin.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Pre Merge pull request !462 from Henry/fix_phpdoc

pull/462/MERGE
Henry 2024-04-01 07:08:11 +00:00 committed by Gitee
parent 8f7a55928c ee0be09841
commit 14fa4804e9
No known key found for this signature in database
GPG Key ID: 173E9B9CA92EEF8F
5 changed files with 53 additions and 53 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
application/api/controller/Common.php
View File

@ -38,9 +38,9 @@ class Common extends Api
/** /**
* 加载初始化 * 加载初始化
* *
* @param string $version 版本号 * @ApiParams (name="version", type="string", required=true, description="版本号")
* @param string $lng 经度 * @ApiParams (name="lng", type="string", required=true, description="经度")
* @param string $lat 纬度 * @ApiParams (name="lat", type="string", required=true, description="纬度")
*/ */
public function init() public function init()
{ {
@ -80,7 +80,7 @@ class Common extends Api
/** /**
* 上传文件 * 上传文件
* @ApiMethod (POST) * @ApiMethod (POST)
* @param File $file 文件流 * @ApiParams (name="file", type="File", required=true, description="文件流")
*/ */
public function upload() public function upload()
{ {
@ -148,7 +148,7 @@ class Common extends Api
/** /**
* 验证码 * 验证码
* @param $id * @ApiParams (name="id", type="string", required=true, description="要生成验证码的标识")
* @return \think\Response * @return \think\Response
*/ */
public function captcha($id = "") public function captcha($id = "")

10
application/api/controller/Ems.php
View File

@ -24,8 +24,8 @@ class Ems extends Api
* 发送验证码 * 发送验证码
* *
* @ApiMethod (POST) * @ApiMethod (POST)
* @param string $email 邮箱 * @ApiParams (name="email", type="string", required=true, description="邮箱")
* @param string $event 事件名称 * @ApiParams (name="event", type="string", required=true, description="事件名称")
*/ */
public function send() public function send()
{ {
@ -68,9 +68,9 @@ class Ems extends Api
* 检测验证码 * 检测验证码
* *
* @ApiMethod (POST) * @ApiMethod (POST)
* @param string $email 邮箱 * @ApiParams (name="email", type="string", required=true, description="邮箱")
* @param string $event 事件名称 * @ApiParams (name="event", type="string", required=true, description="事件名称")
* @param string $captcha 验证码 * @ApiParams (name="captcha", type="string", required=true, description="验证码")
*/ */
public function check() public function check()
{ {

10
application/api/controller/Sms.php
View File

@ -19,8 +19,8 @@ class Sms extends Api
* 发送验证码 * 发送验证码
* *
* @ApiMethod (POST) * @ApiMethod (POST)
* @param string $mobile 手机号 * @ApiParams (name="mobile", type="string", required=true, description="手机号")
* @param string $event 事件名称 * @ApiParams (name="event", type="string", required=true, description="事件名称")
*/ */
public function send() public function send()
{ {
@ -67,9 +67,9 @@ class Sms extends Api
* 检测验证码 * 检测验证码
* *
* @ApiMethod (POST) * @ApiMethod (POST)
* @param string $mobile 手机号 * @ApiParams (name="mobile", type="string", required=true, description="手机号")
* @param string $event 事件名称 * @ApiParams (name="event", type="string", required=true, description="事件名称")
* @param string $captcha 验证码 * @ApiParams (name="captcha", type="string", required=true, description="验证码")
*/ */
public function check() public function check()
{ {

44
application/api/controller/User.php
View File

@ -39,8 +39,8 @@ class User extends Api
* 会员登录 * 会员登录
* *
* @ApiMethod (POST) * @ApiMethod (POST)
* @param string $account 账号 * @ApiParams (name="account", type="string", required=true, description="账号")
* @param string $password 密码 * @ApiParams (name="password", type="string", required=true, description="密码")
*/ */
public function login() public function login()
{ {
@ -62,8 +62,8 @@ class User extends Api
* 手机验证码登录 * 手机验证码登录
* *
* @ApiMethod (POST) * @ApiMethod (POST)
* @param string $mobile 手机号 * @ApiParams (name="mobile", type="string", required=true, description="手机号")
* @param string $captcha 验证码 * @ApiParams (name="captcha", type="string", required=true, description="验证码")
*/ */
public function mobilelogin() public function mobilelogin()
{ {
@ -101,11 +101,11 @@ class User extends Api
* 注册会员 * 注册会员
* *
* @ApiMethod (POST) * @ApiMethod (POST)
* @param string $username 用户名 * @ApiParams (name="username", type="string", required=true, description="用户名")
* @param string $password 密码 * @ApiParams (name="password", type="string", required=true, description="密码")
* @param string $email 邮箱 * @ApiParams (name="email", type="string", required=true, description="邮箱")
* @param string $mobile 手机号 * @ApiParams (name="mobile", type="string", required=true, description="手机号")
* @param string $code 验证码 * @ApiParams (name="code", type="string", required=true, description="验证码")
*/ */
public function register() public function register()
{ {
@ -153,10 +153,10 @@ class User extends Api
* 修改会员个人信息 * 修改会员个人信息
* *
* @ApiMethod (POST) * @ApiMethod (POST)
* @param string $avatar 头像地址 * @ApiParams (name="avatar", type="string", required=true, description="头像地址")
* @param string $username 用户名 * @ApiParams (name="username", type="string", required=true, description="用户名")
* @param string $nickname 昵称 * @ApiParams (name="nickname", type="string", required=true, description="昵称")
* @param string $bio 个人简介 * @ApiParams (name="bio", type="string", required=true, description="个人简介")
*/ */
public function profile() public function profile()
{ {
@ -189,8 +189,8 @@ class User extends Api
* 修改邮箱 * 修改邮箱
* *
* @ApiMethod (POST) * @ApiMethod (POST)
* @param string $email 邮箱 * @ApiParams (name="email", type="string", required=true, description="邮箱")
* @param string $captcha 验证码 * @ApiParams (name="captcha", type="string", required=true, description="验证码")
*/ */
public function changeemail() public function changeemail()
{ {
@ -224,8 +224,8 @@ class User extends Api
* 修改手机号 * 修改手机号
* *
* @ApiMethod (POST) * @ApiMethod (POST)
* @param string $mobile 手机号 * @ApiParams (name="mobile", type="string", required=true, description="手机号")
* @param string $captcha 验证码 * @ApiParams (name="captcha", type="string", required=true, description="验证码")
*/ */
public function changemobile() public function changemobile()
{ {
@ -259,8 +259,8 @@ class User extends Api
* 第三方登录 * 第三方登录
* *
* @ApiMethod (POST) * @ApiMethod (POST)
* @param string $platform 平台名称 * @ApiParams (name="platform", type="string", required=true, description="平台名称")
* @param string $code Code码 * @ApiParams (name="code", type="string", required=true, description="Code码")
*/ */
public function third() public function third()
{ {
@ -291,9 +291,9 @@ class User extends Api
* 重置密码 * 重置密码
* *
* @ApiMethod (POST) * @ApiMethod (POST)
* @param string $mobile 手机号 * @ApiParams (name="mobile", type="string", required=true, description="手机号")
* @param string $newpassword 新密码 * @ApiParams (name="newpassword", type="string", required=true, description="新密码")
* @param string $captcha 验证码 * @ApiParams (name="captcha", type="string", required=true, description="验证码")
*/ */
public function resetpwd() public function resetpwd()
{ {

32
application/api/controller/Validate.php
View File

@ -23,8 +23,8 @@ class Validate extends Api
* 检测邮箱 * 检测邮箱
* *
* @ApiMethod (POST) * @ApiMethod (POST)
* @param string $email 邮箱 * @ApiParams (name="email", type="string", required=true, description="邮箱")
* @param string $id 排除会员ID * @ApiParams (name="id", type="string", required=true, description="排除会员ID")
*/ */
public function check_email_available() public function check_email_available()
{ {
@ -41,8 +41,8 @@ class Validate extends Api
* 检测用户名 * 检测用户名
* *
* @ApiMethod (POST) * @ApiMethod (POST)
* @param string $username 用户名 * @ApiParams (name="username", type="string", required=true, description="用户名")
* @param string $id 排除会员ID * @ApiParams (name="id", type="string", required=true, description="排除会员ID")
*/ */
public function check_username_available() public function check_username_available()
{ {
@ -59,8 +59,8 @@ class Validate extends Api
* 检测昵称 * 检测昵称
* *
* @ApiMethod (POST) * @ApiMethod (POST)
* @param string $nickname 昵称 * @ApiParams (name="nickname", type="string", required=true, description="昵称")
* @param string $id 排除会员ID * @ApiParams (name="id", type="string", required=true, description="排除会员ID")
*/ */
public function check_nickname_available() public function check_nickname_available()
{ {
@ -77,8 +77,8 @@ class Validate extends Api
* 检测手机 * 检测手机
* *
* @ApiMethod (POST) * @ApiMethod (POST)
* @param string $mobile 手机号 * @ApiParams (name="mobile", type="string", required=true, description="手机号")
* @param string $id 排除会员ID * @ApiParams (name="id", type="string", required=true, description="排除会员ID")
*/ */
public function check_mobile_available() public function check_mobile_available()
{ {
@ -95,7 +95,7 @@ class Validate extends Api
* 检测手机 * 检测手机
* *
* @ApiMethod (POST) * @ApiMethod (POST)
* @param string $mobile 手机号 * @ApiParams (name="mobile", type="string", required=true, description="手机号")
*/ */
public function check_mobile_exist() public function check_mobile_exist()
{ {
@ -111,7 +111,7 @@ class Validate extends Api
* 检测邮箱 * 检测邮箱
* *
* @ApiMethod (POST) * @ApiMethod (POST)
* @param string $mobile 邮箱 * @ApiParams (name="email", type="string", required=true, description="邮箱")
*/ */
public function check_email_exist() public function check_email_exist()
{ {
@ -127,9 +127,9 @@ class Validate extends Api
* 检测手机验证码 * 检测手机验证码
* *
* @ApiMethod (POST) * @ApiMethod (POST)
* @param string $mobile 手机号 * @ApiParams (name="mobile", type="string", required=true, description="手机号")
* @param string $captcha 验证码 * @ApiParams (name="captcha", type="string", required=true, description="验证码")
* @param string $event 事件 * @ApiParams (name="event", type="string", required=true, description="事件")
*/ */
public function check_sms_correct() public function check_sms_correct()
{ {
@ -146,9 +146,9 @@ class Validate extends Api
* 检测邮箱验证码 * 检测邮箱验证码
* *
* @ApiMethod (POST) * @ApiMethod (POST)
* @param string $email 邮箱 * @ApiParams (name="email", type="string", required=true, description="邮箱")
* @param string $captcha 验证码 * @ApiParams (name="captcha", type="string", required=true, description="验证码")
* @param string $event 事件 * @ApiParams (name="event", type="string", required=true, description="事件")
*/ */
public function check_ems_correct() public function check_ems_correct()
{ {