anessoft/

yii2-apidoc

用于自动加载接口文档及提供接口调试

维护者

详细信息

git.oschina.net/anes/yii2-apidoc.git

安装: 3

依赖者: 0

建议者: 0

安全: 0

类型:yii2-extension

v0.0.1 2018-01-05 09:00 UTC

This package is auto-updated.

Last update: 2020-08-06 00:44:04 UTC


README

安装

composer require anessoft/yii2-apidoc

访问

http://xx.com/apidoc

排除

排除有属性$noapidoc的控制器 例如

class DefaultController extends \yii\web\Controller
{
    public $noapidoc;
    ...
}

排除命名为^test(\w+)$的方法 例如

    ...
    public function actionTestimport(){
        ...
    }
    ...

方法名

方法注释第一行

自定义接口测试

第二行如果命名^testApi:(.+)$$1为接口测试地址

使用示例

$config['bootstrap'][] = 'apidoc';
$config['modules']['apidoc'] = [
      'class' => 'anes\apidoc\Module',
   ];

必须在控制器基类添加以下行

use \anes\apidoc\components\BaseApidoc;