·您现在的位置: 云翼网络 >> 文章中心 >> 网站建设 >> 网站建设开发 >> php网站开发 >> Yii2 基于RESTful架构的 advanced版API接口开发 配置、实现、测试

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

作者:佚名      php网站开发编辑:admin      更新时间:2022-07-23
Yii2 基于RESTful架构的 advanced版API接口开发 配置、实现、测试环境配置:开启服务器伪静态

本处以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文件如下:

 1 <?php 2 namespace api\modules\v1; 3  4 class Module extends \yii\base\Module 5 { 6  7     public $controllerNamespace = 'api\modules\v1\controllers'; 8  9     public function 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  4 return [ 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) 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文件夹中,并注意命名空间的修改。

 1 <?php 2 namespace api\modules\v1\models; 3  4 use Yii; 5 use yii\db\ActiveRecord; 6 use yii\web\IdentityInterface; 7  8 /** 9  * This is the model class for table "{{%guide}}".10  *11  * @property integer $id12  * @property string $imgurl13  * @property integer $status14  * @property integer $flag15  */16 class Guide extends ActiveRecord implements IdentityInterface17 {18 19     public static function findIdentityByAccessToken($token, $type = null)20     {21         return static::findOne([22             'access_token' => $token23         ]);24     }25 26     public function getId()27     {28         return $this->id;29     }30 31     public function getAuthKey()32     {33         return $this->authKey;34     }35 36     public function validateAuthKey($authKey)37     {38         return $this->authKey === $authKey;39     }40 41     public static function findIdentity($id)42     {43         return static::findOne($id);44     }45 46     public static function tableName()47     {48         return '{{%guide}}';49     }50 51     public function rules()52     {53         return [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' => 25575             ]76         ];77     }78 79     public function attributeLabels()80     {81         return [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.php3、创建一个控制器
 1 <?php 2 namespace api\modules\v1\controllers; 3  4 use Yii; 5 use yii\rest\ActiveController; 6 use yii\filters\auth\CompositeAuth; 7 use yii\filters\auth\QueryParamAuth; 8 use yii\data\ActiveDataProvider; 9 10 class SiteController extends ActiveController11 {12 13     public $modelClass = 'api\modules\v1\models\guide';14 15     public $serializer = [16         'class' => 'yii\rest\Serializer',17         'collectionEnvelope' => 'items'18     ];19     20     // public function behaviors()21     // {22     // $behaviors = parent::behaviors();23     // $behaviors['authenticator']