PHP download

PHP code example of kedeemaul / yii2-apidoc

1. Go to this page and download the library: Download kedeemaul/yii2-apidoc library. Choose the download type require.

2. Extract the ZIP file and open the index.php.

3. Add this code to the index.php.

    
        
<?php
require_once('vendor/autoload.php');

/* Start to develop here. Best regards https://php-download.com/ */

kedeemaul / yii2-apidoc example snippets


composer


'modules' => [
        'docs' => [
            'class' => 'yii2docs\apidoc\Module',
            # 和配置时定义的模块名一致
            'moduleName' => 'docs',
        ]
    ]


return [
    'apiList' => [
        [
            'label' => '文档测试1',//文档分组名称
            'debugHost' => 'http://apidoc.yii2.com:802',//调试api访问域名，不配置或留空，默认为当前HOST
            'class' => 'apidoc\controllers\UserController',//class为api所在的控制器
        ],
        [
            'label' => '文档测试2',//文档分组名称
            'debugHost' => 'http://admin.yii2.com:802',//调试api访问域名，不配置或留空，默认为当前HOST
            'class' => 'backend\controllers\SystemController',//class为api所在的控制器
        ],
    ],
];


/**
* @name 获取注册验证码
* @uses 用户注册是拉取验证码
* @method get
* @author kedee
* @create 创建日期
* @request 参数传递说明，如“参数名以*号开头表示必填”
* @param string *phone 手机号
* @response 返回JSON结构体，具体键值如下
* @return int status 状态码：1正常，0错误
* @return string msg 提示消息内容
* @return array data 返回消息体数组
*/
public function actionRegGetCode($phone)
{
}


/**
* @name 动作方法名称
* @uses 方法用途说明
* @method get
* @author ${DEVUSER}
* @create ${DATE} ${TIME}
* @request 参数名以*号开头表示必填
 ${PARAM_DOC}
* @param 类型 参数名 参数说明
 #if (${TYPE_HINT} != "void")
* @response ${TYPE_HINT} 返回JSON结构体，具体键值如下
* @return int status 状态码：1正常，0错误
* @return string msg 提示消息内容
* @return array data 返回消息体数组
#end
${THROWS_DOC}
 */