jiang704593835/yii2-doc

There is no license information available for the latest version (v1.0.0) of this package.

v1.0.0 2022-04-15 06:31 UTC

Requires

• yiisoft/yii2: ~2.0.7

Unknown License

• jianghaiyan

README

auto generate api document by using comment for yii2.

Installation

composer require jiang704593835/yii2-doc

Configure

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

Use

/**
 * @doc-module 登录
 */
class UserController extends Controller {

doc-param 类型 字段 描述 默认值 是否必须

doc-return 类型 返回定义 描述

/**
 * @doc-name 用户详情
 * @doc-param string username 用户名称 / optional
 * @doc-desc 获取用户详情
 * @doc-return mixed @List{@User-mixed-用户信息{username-string-用户名,mobile},name-string-姓名,age-int-年龄,@Activity{*[id|title],@ActivityData{*}}} 用户详情
 * @doc-return mixed @Pagination{per_page-string-分页} 分页数据
 * @doc-return string name 名称
 */
public function actionDetail()