yii2-doc - YII2 接口文档工具


GPL
跨平台
PHP

软件简介

YII2接口文档工具:

使用注释自动生成基于YII2的接口文档,自动获取模型中注释。

安装方式

composer require chatfeed/yii2-doc "*"

配置

    'module'=>[
        'doc' => [
            'class' => 'cfd\doc\Module',
            'modelDescriptions'=>require __DIR__.'/model_description.php',
            'modelsMap'=>[
                '\common\base_models\kds\\',
            ]
        ]
    ]

用户自定义模型

return [
    'demo'=>[
        ['object','demo','模型'],
        ['integer','id','ID'],
        ['string','name','名称'],
        ['string','desc','描述'],
        ['integer','created_at','创建时间'],
        ['integer','updated_at','更新时间'],
    ]
];