Yii2 基于RESTful架构的 advanced版API接口开发配置、实现、测试

2022-04-28 01:08:53

环境配置：

开启服务器伪静态

本处以apache为例，查看apache的conf目录下httpd.conf，找到下面的代码

LoadModule rewrite_module modules/mod_rewrite.so

将其前面的#去掉，如果没有找到则添加进去。

找到一下代码

<Directory "C:/phpStudy/Apache/cgi-bin">

    AllowOverride All

    Options None

    Require all granted

</Directory>

将原本的AllowOverride None改为AllowOverride All。

然后在站点根目录下创建一个.htaccess文件，内容如下：

<IfModule mod_rewrite.c>

  Options +FollowSymlinks

  RewriteEngine On

  RewriteCond %{REQUEST_FILENAME} !-d

  RewriteCond %{REQUEST_FILENAME} !-f

  RewriteRule . index.php

</IfModule>

.htaccess

此处不再赘述yii2的配置，如果需要可以看YII2实战手册。

YII2实际操作:

1、配置URL规则及modules

（1）新建modules文件夹，实行api接口版本控制。例如V1版本、V2版本……

在v1文件夹下新建controllers文件夹（控制器）、models文件夹（模型）、Module.php配置文件。

Module.php文件如下：

 <?php

 namespace api\modules\v1;

 class Module extends \yii\base\Module

 {

     public $controllerNamespace = 'api\modules\v1\controllers';

     public function init()

     {

         parent::init();

     }

 }

第2行和第7行随版本扩展而变化（v1->v2...）。

（2）配置config文件夹下的main.php文件

 <?php

 $params = array_merge(require (__DIR__ . '/../../common/config/params.php'), require (__DIR__ . '/../../common/config/params-local.php'), require (__DIR__ . '/params.php'), require (__DIR__ . '/params-local.php'));

 return [

     'id' => 'app-api',

     'basePath' => dirname(__DIR__),

     'bootstrap' => [

         'log'

     ],

     'modules' => [

         'v1' => [

             'class' => 'api\modules\v1\Module'

         ],

         'v2' => [

             'class' => 'api\modules\v2\Module'

         ]

     ],

     'controllerNamespace' => 'api\controllers',

     'components' => [

         'user' => [

             'identityClass' => 'common\models\User',

             'enableAutoLogin' => false,

             'enableSession' => false,

             'loginUrl' => null

         ],

         'urlManager' => [

             'enablePrettyUrl' => true, // 启用美化URL

             'enableStrictParsing' => true, // 是否执行严格的url解析

             'showScriptName' => false, // 在URL路径中是否显示脚本入口文件

             'rules' => [

                 [

                     'class' => 'yii\rest\UrlRule',

                     'controller' => [

                         'v1/site'

                     ]

                 ],

                 [

                     'class' => 'yii\rest\UrlRule',

                     'controller' => [

                         'v2/site'

                     ]

                 ]

             ]

         ],

         'log' => [

             'traceLevel' => YII_DEBUG ? 3 : 0,

             'targets' => [

                 [

                     'class' => 'yii\log\FileTarget',

                     'levels' => [

                         'error',

                         'warning'

                     ]

                 ]

             ]

         ],

         'errorHandler' => [

             'errorAction' => 'site/error'

         ]

     ],

     'params' => $params

 ];

main.php

注意10~17行、20~44行的组件配置，相信大家仔细阅读就能明白，此处不再赘述原理，请大家尤其注意33~35行的代码，此处表示的是v1/site控制器，随着接口控制器的增多，可以直接在数组中增加即可。本文力求快速配置出RESTful架构的实现。

（3）v2、v3表示以后的版本变化，配置都类似于v1文件夹。

2、创建一个模型

数据库准备一个名为mxq_guide的数据表

CREATE TABLE `mxq_guide` (

  `id` int(11) NOT NULL AUTO_INCREMENT,

  `imgurl` varchar(255) DEFAULT NULL COMMENT '图片路径', 
  `status` int(11) DEFAULTNULL COMMENT '1启用 0禁用',
  `flag` int(11) DEFAULTNULL COMMENT '1安卓 2苹果', 
   PRIMARY KEY (`id`) 
   ) ENGINE=MyISAM AUTO_INCREMENT=24 DEFAULT CHARSET=utf8 COMMENT='APP导航图';

创建后请注意及时往数据库添加几条数据信息。

通过脚手架gii来创建guide.php模型（使用方法请看yii2权威指南）。生成后的文件注意改写，修改为如下形式以满足RESTful的需求。之后从models文件夹中转移到v1/models文件夹中，并注意命名空间的修改。

 <?php

 namespace api\modules\v1\models;

 use Yii;

 use yii\db\ActiveRecord;

 use yii\web\IdentityInterface;

 /**

  * This is the model class for table "{{%guide}}".

  *

  * @property integer $id

  * @property string $imgurl

  * @property integer $status

  * @property integer $flag

  */

 class Guide extends ActiveRecord implements IdentityInterface

 {

     public static function findIdentityByAccessToken($token, $type = null)

     {

         return static::findOne([

             'access_token' => $token

         ]);

     }

     public function getId()

     {

         return $this->id;

     }

     public function getAuthKey()

     {

         return $this->authKey;

     }

     public function validateAuthKey($authKey)

     {

         return $this->authKey === $authKey;

     }

     public static function findIdentity($id)

     {

         return static::findOne($id);

     }

     public static function tableName()

     {

         return '{{%guide}}';

     }

     public function rules()

     {

         return [

             [

                 [

                     'imgurl',

                     'status',

                     'flag'

                 ],

                 'required'

             ],

             [

                 [

                     'status',

                     'flag'

                 ],

                 'integer'

             ],

             [

                 [

                     'imgurl'

                 ],

                 'string',

                 'max' => 255

             ]

         ];

     }

     public function attributeLabels()

     {

         return [

             'id' => Yii::t('app', 'ID'),

             'imgurl' => Yii::t('app', 'imgurl'),

             'status' => Yii::t('app', 'status'),

             'flag' => Yii::t('app', 'flag')

         ];

     }

 }

guide.php

3、创建一个控制器

 <?php

 namespace api\modules\v1\controllers;

 use Yii;

 use yii\rest\ActiveController;

 use yii\filters\auth\CompositeAuth;

 use yii\filters\auth\QueryParamAuth;

 use yii\data\ActiveDataProvider;

 class SiteController extends ActiveController

 {

     public $modelClass = 'api\modules\v1\models\guide';

     public $serializer = [

         'class' => 'yii\rest\Serializer',

         'collectionEnvelope' => 'items'

     ];

     // public function behaviors()

     // {

     // $behaviors = parent::behaviors();

     // $behaviors['authenticator'] = [

     // 'class' => CompositeAuth::className(),

     // 'authMethods' => [

     // QueryParamAuth::className()

     // ]

     // ];

     // return $behaviors;

     // }

     public function actions()

     {

         $actions = parent::actions();

         // 注销系统自带的实现方法

         unset($actions['index'], $actions['update'], $actions['create'], $actions['delete'], $actions['view']);

         return $actions;

     }

     public function actionIndex()

     {

         $modelClass = $this->modelClass;

         $query = $modelClass::find();

         return new ActiveDataProvider([

             'query' => $query

         ]);

     }

     public function actionCreate()

     {

         $model = new $this->modelClass();

         // $model->load(Yii::$app->getRequest()

         // ->getBodyParams(), '');

         $model->attributes = Yii::$app->request->post();

         if (! $model->save()) {

             return array_values($model->getFirstErrors())[0];

         }

         return $model;

     }

     public function actionUpdate($id)

     {

         $model = $this->findModel($id);

         $model->attributes = Yii::$app->request->post();

         if (! $model->save()) {

             return array_values($model->getFirstErrors())[0];

         }

         return $model;

     }

     public function actionDelete($id)

     {

         return $this->findModel($id)->delete();

     }

     public function actionView($id)

     {

         return $this->findModel($id);

     }

     protected function findModel($id)

     {

         $modelClass = $this->modelClass;

         if (($model = $modelClass::findOne($id)) !== null) {

             return $model;

         } else {

             throw new NotFoundHttpException('The requested page does not exist.');

         }

     }

     public function checkAccess($action, $model = null, $params = [])

     {

         // 检查用户能否访问 $action 和 $model

         // 访问被拒绝应抛出ForbiddenHttpException

         // var_dump($params);exit;

     }

 }