README

安装

安装此扩展的首选方式是通过 composer。

注意：请检查此扩展的composer.json文件，以了解其要求和依赖。阅读此网络提示/维基了解如何设置应用程序的composer.json中的minimum-stability设置。

运行以下命令之一：

$ php composer.phar require esempla/yii2-rest-generator "1.0.*"

或添加以下内容到您的composer.json文件的require部分。

"esempla/yii2-rest-generator": "1.0.*"

到

迁移

此扩展已创建具有数据库表。您应该执行数据库迁移。（推荐使用 PostgreSQL ®）

 php yii migrate/up  --migrationPath="vendor/esempla/yii2-rest-generator/src/migrations" 

模块

此扩展已创建为模块。您应按照以下示例配置名为restGenerator的模块

'modules' => [
	...
	 'restGenerator' => [
                'class' => 'restGenerator\Module',
                'params' => [
                    'modelsPath' => Yii::getAlias("@common") , //path for models scaning
                    'controllersPath' => Yii::getAlias("@backend") . "/modules/v1/controllers", //path where to save controllers
                    'controllersNS' => 'backend\modules\v1\controllers', //namespace for the new controllers
                    'auth_method'=>'Basic Auth'// Can be : Bearer Auth, Basic Auth
                ]
            ],
	...
],

`v1！必须是模块，您可以设置其他名称，但此必须为模块。

为src路径设置别名（推荐使用/common/main.php）

'aliases' => [  
    ...  
    '@restGenerator' => '@vendor/esempla/yii2-rest-generator/src',  
],

在common或backend中的bootstrap.php中添加

Yii::setAlias('@restGenerator', dirname(dirname(__DIR__)) . '/vendor/esempla/rest-generator/src');  

添加RestGeneratorRoute以进行动态API路由（推荐使用/backend/main.php）

如果向模块添加新控制器，这将为此设置默认REST规则。

'bootstrap' => [
    ...
    'restGenerator\components\RestGeneratorRoute'
],

设置建议

'components' => [
    ...
    'urlManager' => [
          'class' => 'yii\web\UrlManager',
          'showScriptName' => false,   // Disable index.php
          'enablePrettyUrl' => true,  
        'rules' => [
            ...

    ],
],
'user' => [
            'class' => 'common\components\UserIdentity',
            'identityClass' => 'common\modules\User\models\User',
            'enableAutoLogin' => false,
            'enableSession' =>false
        ],

],

### Important ! set file access by example
 

sudo chown -R root:www-data backend/modules/v1/controllers

### Also remove RBAC for new controllers

'as access' => [

    'class' => AccessControl::className(),
    'allowActions' => [
        'site/*',
        'test/*',
        'v1/*',//for example
        'restGenerator/login/*'
    ]
],

<h2>Required for yii2-rest-generator:</h2>
<h4>Composer Require:</h4>

"sizeg/yii2-jwt": "dev-master"

<h4>Configure:</h4>

'components' => [
    'jwt' => [
        'class' => 'sizeg\jwt\Jwt',
        'key'   => 'secret',
    ],
      'user' => [
                'class' => 'common\components\UserIdentity',
                'identityClass' => 'common\modules\User\models\User',
                'enableAutoLogin' => false,
                'enableSession' =>false
            ],
    ]

<h4>Set common/config/params-local.php </h4>

'secret_key_api_token'=>'yor secret key',

## To acces module

> **Go to** <u> http:://domain_name/restGenerator</u>