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

程序员文章站 2022-06-13 23:51:52

...

环境配置：

开启服务器伪静态

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

LoadModule rewrite_module modules/mod_rewrite.so

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

找到一下代码

    AllowOverride All
    Options None
    Require all granted

将原本的AllowOverride None改为AllowOverride All。

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

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

  Options +FollowSymlinks
  RewriteEngine On
  RewriteCond %{REQUEST_FILENAME} !-d
  RewriteCond %{REQUEST_FILENAME} !-f
  RewriteRule . index.php

.htaccess

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

YII2实际操作:

1、配置URL规则及modules

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

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

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

Module.php文件如下：

 1 php
 2namespace api\modules\v1;
 3 4class Module extends \yii\base\Module
 5{
 6 7public$controllerNamespace = 'api\modules\v1\controllers';
 8 9publicfunction init()
10    {
11         parent::init();
12    }
13 }

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

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

 1 php
 2$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'));
 3 4return [
 5     'id' => 'app-api',
 6     'basePath' => dirname(__DIR__),
 7     'bootstrap' => [
 8         'log'
 9     ],
10     'modules' => [
11         'v1' => [
12             'class' => 'api\modules\v1\Module'
13         ],
14         'v2' => [
15             'class' => 'api\modules\v2\Module'
16        ]
17     ],
18     'controllerNamespace' => 'api\controllers',
19     'components' => [
20         'user' => [
21             'identityClass' => 'common\models\User',
22             'enableAutoLogin' => false,
23             'enableSession' => false,
24             'loginUrl' => null25         ],
26         'urlManager' => [
27             'enablePrettyUrl' => true, // 启用美化URL28             'enableStrictParsing' => true, // 是否执行严格的url解析29             'showScriptName' => false, // 在URL路径中是否显示脚本入口文件30             'rules' => [
31                [
32                     'class' => 'yii\rest\UrlRule',
33                     'controller' => [
34                         'v1/site'
35                    ]
36                 ],
37                [
38                     'class' => 'yii\rest\UrlRule',
39                     'controller' => [
40                         'v2/site'
41                    ]
42                ]
43            ]
44         ],
45         'log' => [
46             'traceLevel' => YII_DEBUG ? 3 : 0,
47             'targets' => [
48                [
49                     'class' => 'yii\log\FileTarget',
50                     'levels' => [
51                         'error',
52                         'warning'
53                    ]
54                ]
55            ]
56         ],
57         'errorHandler' => [
58             'errorAction' => 'site/error'
59        ]
60     ],
61     'params' => $params62 ];

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) DEFAULTNULL 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文件夹中，并注意命名空间的修改。

 1 php
 2namespace api\modules\v1\models;
 3 4use Yii;
 5use yii\db\ActiveRecord;
 6use yii\web\IdentityInterface;
 7 8/**
 9 * This is the model class for table "{{%guide}}".
10 *
11 * @property integer $id
12 * @property string $imgurl
13 * @property integer $status
14 * @property integer $flag
15*/16class Guide extends ActiveRecord implements IdentityInterface
17{
1819publicstaticfunction findIdentityByAccessToken($token, $type = null)
20    {
21returnstatic::findOne([
22             'access_token' => $token23        ]);
24    }
2526publicfunction getId()
27    {
28return$this->id;
29    }
3031publicfunction getAuthKey()
32    {
33return$this->authKey;
34    }
3536publicfunction validateAuthKey($authKey)
37    {
38return$this->authKey === $authKey;
39    }
4041publicstaticfunction findIdentity($id)
42    {
43returnstatic::findOne($id);
44    }
4546publicstaticfunction tableName()
47    {
48return '{{%guide}}';
49    }
5051publicfunction rules()
52    {
53return [
54            [
55                [
56                     'imgurl',
57                     'status',
58                     'flag'
59                 ],
60                 'required'
61             ],
62            [
63                [
64                     'status',
65                     'flag'
66                 ],
67                 'integer'
68             ],
69            [
70                [
71                     'imgurl'
72                 ],
73                 'string',
74                 'max' => 255
75            ]
76        ];
77    }
7879publicfunction attributeLabels()
80    {
81return [
82             'id' => Yii::t('app', 'ID'),
83             'imgurl' => Yii::t('app', 'imgurl'),
84             'status' => Yii::t('app', 'status'),
85             'flag' => Yii::t('app', 'flag')
86        ];
87    }
88 }

guide.php

3、创建一个控制器

 1 php
 2namespace api\modules\v1\controllers;
 3 4use Yii;
 5use yii\rest\ActiveController;
 6use yii\filters\auth\CompositeAuth;
 7use yii\filters\auth\QueryParamAuth;
 8use yii\data\ActiveDataProvider;
 910class SiteController extends ActiveController
11{
1213public$modelClass = 'api\modules\v1\models\guide';
1415public$serializer = [
16         'class' => 'yii\rest\Serializer',
17         'collectionEnvelope' => 'items'
18    ];
1920// public function behaviors()
21    // {
22    // $behaviors = parent::behaviors();
23    // $behaviors['authenticator'] = [
24    // 'class' => CompositeAuth::className(),
25    // 'authMethods' => [
26    // QueryParamAuth::className()
27    // ]
28    // ];
29    // return $behaviors;
30    // }31publicfunction actions()
32    {
33$actions = parent::actions();
34// 注销系统自带的实现方法35unset($actions['index'], $actions['update'], $actions['create'], $actions['delete'], $actions['view']);
36return$actions;
37    }
3839publicfunction actionIndex()
40    {
41$modelClass = $this->modelClass;
42$query = $modelClass::find();
43returnnew ActiveDataProvider([
44             'query' => $query45        ]);
46    }
4748publicfunction actionCreate()
49    {
50$model = new$this->modelClass();
51// $model->load(Yii::$app->getRequest()
52        // ->getBodyParams(), '');53$model->attributes = Yii::$app->request->post();
54if (! $model->save()) {
55returnarray_values($model->getFirstErrors())[0];
56        }
57return$model;
58    }
5960publicfunction actionUpdate($id)
61    {
62$model = $this->findModel($id);
63$model->attributes = Yii::$app->request->post();
64if (! $model->save()) {
65returnarray_values($model->getFirstErrors())[0];
66        }
67return$model;
68    }
6970publicfunction actionDelete($id)
71    {
72return$this->findModel($id)->delete();
73    }
7475publicfunction actionView($id)
76    {
77return$this->findModel($id);
78    }
7980protectedfunction findModel($id)
81    {
82$modelClass = $this->modelClass;
83if (($model = $modelClass::findOne($id)) !== null) {
84return$model;
85         } else {
86thrownew NotFoundHttpException('The requested page does not exist.');
87        }
88    }
8990publicfunction checkAccess($action, $model = null, $params = [])
91    {
92// 检查用户能否访问 $action 和 $model
93        // 访问被拒绝应抛出ForbiddenHttpException
94        // var_dump($params);exit;95    }
96 }