chatfeed/yii2-doc

auto document tool for Yii2

dev-master 2018-01-06 01:29 UTC

Requires

• yiisoft/yii2: ~2.0.7

BSD-3-Clause

• chatfeed

• api
• doc
• yii2

README

====================== auto generate api document by using comment for yii2.

Installation

composer require chatfeed/yii2-doc "*"

Configure

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

Define Customer Model

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

Screenshot

Thanks yii2-fast-api