这篇文章主要介绍了Yii2.0 RESTful API 基础配置教程,小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧。

最近在做Yii2.0 RESTful API功能，找了好久的资料，才找到这类的教程，感谢该作者，以下内容根据我的项目实际情况做了一定的修改。

安装yii2.0

安装 Composer 后，您可以通过在 Web 可访问的文件夹下运行以下命令来 安装Yii应用程序模板：

composer create-project --prefer-dist yiisoft/yii2-app-basic basic

初始化高级模板

cd advanced

./init

输入"./init"后会出现以下内容

1. Yii Application Initialization Tool v1.0 
2.  
3. Which environment do you want the application to be initialized in? 
4.  
5.   [0] Development 
6.   [1] Production 
7.  
8.   Your choice [0-1, or "q" to quit] 0 
9.  
10.   Initialize the application under 'Development' environment? [yes|no] yes 
11.  
12.   Start initialization ... 

修改数据库连接属性

打开 commonconfigmain-local.php,配置数据库连接信息

1. 'db' => [ 
2.       'class' => 'yii\db\Connection', 
3.       'dsn' => 'mysql:host=127.0.0.1;dbname=yii', 
4.       'username' => 'root', 
5.       'password' => 'root', 
6.       'charset' => 'utf8', 
7.     ], 

执行 migrate 数据库迁移

./yii migrate

拷贝backend目录，命名为api

打开apiconfigmain.php 修改id,controllerNamespace等，将所有backend替换为api：

1. return [ 
2.   'id' => 'app-api', 
3.   'basePath' => dirname(__DIR__), 
4.   'controllerNamespace' => 'api\controllers', 
5. ] 

打开apiconfigmain.php开启url路由美化规则

1. 'urlManager' => [ 
2.       'enablePrettyUrl' => true, 
3.       'showScriptName' => false, 
4.       'rules' => [ 
5.       ], 
6.     ], 

打开commonconfigbootstrap.php添加以下别名

Yii::setAlias('@api', dirname(dirname(__DIR__)) . '/api');

为什么要单独创建API应用

单独创建API应用，目的是便于维护，可以避免以下问题

配置的冲突

控制器的命名不便

url美化规则冲突

分工明确frontend为前台目录；backend为后台目录；api为api目录

接下来打开 apicontrollers 新建一个User控制器，继承 yiirestActiveController，命名为 UserController,代码如下：

1. <?php 
2. namespace api\controllers; 
3. use yii\rest\ActiveController; 
4.  
5. class UserController extends ActiveController 
6. { 
7.   public $modelClass = 'common\models\User'; 
8.     
9. } 

配置URL规则

为刚才的 user控制器添加url美化规则

打开 apiconfigmain.php 修改 components属性，添加下列代码:

1. ... 
2. 'urlManager' => [ 
3.   'enablePrettyUrl' => true, 
4.   'enableStrictParsing' => true, 
5.   'showScriptName' => false, 
6.   'rules' => [ 
7.     ['class' => 'yii\rest\UrlRule',  
8.     'controller' => 'user' 
9.     ], 
10.   ], 
11. ] 
12.  
13. ... 

ok，到此就成了一个 符合 RESTful 风格的API

看起来在控制器了什么也没有写，只是指定了一个模型，但是她的背后完成了很多的功能哦，列表如下：

GET /users: 逐页列出所有用户

HEAD /users: 显示用户列表的概要信息

POST /users: 创建一个新用户

GET /users/123: 返回用户 123 的详细信息

HEAD /users/123: 显示用户 123 的概述信息

PATCH /users/123: and PUT /users/123: 更新用户123

DELETE /users/123: 删除用户123

OPTIONS /users: 显示关于末端 /users 支持的动词

OPTIONS /users/123: 显示有关末端 /users/123 支持的动词

如何访问呢

你可以使用 curl命令进行访问,命令如下:

curl -i -H "Accept:application/json" <a href="http://localhost/users">http://localhost/users</a>

命令行下还是比较麻烦的，也不方便测试，推荐使用 API测试工具

这类的工具有很多，我就不一一列举了，这里推荐 Postman,很好很强大，Chorme也有插件，可以安装，这里我推荐直接下载软件安装调试，比较方便

你可能发现了 访问任何路由地址都是加的s,users ， 为什么呢? 资源，你要理解 资源二字，既然是资源肯定是个集合，肯定有一大堆，所以要加上复数，我是这么理解的。

你说我就是不想加上s,我就想采用http://localhost/user 这种方式来进行访问，好吧，可以，满足你，只是不推荐

继续打开配置文件apiconfigmain.php修改刚才添加的 urlManager 如下:

1. 'urlManager' => [ 
2.   'enablePrettyUrl' => true, 
3.   'enableStrictParsing' => true, 
4.   'showScriptName' => false, 
5.   'rules' => [ 
6.     ['class' => 'yii\rest\UrlRule',  
7.     'controller' => 'user', 
8.     'pluralize' => false,  //设置为false 就可以去掉复数形式了 
9.     ], 
10.   ], 
11. ] 

加入 'pluralize' => false, 就表示去掉复数形式了，再次强调不推荐

ok，在控制器中我们没有写任何一句代码，他就给我们生成许多方法，但是有时候我们可能需要修改一些代码，来达到我们想要的效果，比如连表查询，然后再返回数据

接下来我们就实现这样的功能:

打开刚才新建的user控制器, 重写 action方法:

1. <?php 
2.  
3. namespace api\controllers; 
4. use yii\rest\ActiveController; 
5.  
6. class UserController extend extends ActiveController 
7. { 
8.   public $modelClass = 'common\models\User'; 
9.     
10.   public function actions() 
11.   { 
12.     $action= parent::actions(); // TODO: Change the autogenerated stub 
13.     unset($action['index']); 
14.     unset($action['create']); 
15.     unset($action['update']); 
16.     unset($action['delete']); 
17.   } 
18.     
19.   public function actionIndex() 
20.   { 
21.     //你的代码 
22.   } 
23.     
24. } 

这样我们就可以重写他的代码了，哈哈

我们再新建一个自己的 action

1. <?php 
2.  
3. namespace api\controllers; 
4. use yii\rest\ActiveController; 
5.  
6. class UserController extends ActiveController 
7. { 
8.   public $modelClass = 'common\models\User'; 
9.     
10.   public function actions() 
11.   { 
12.     $action= parent::actions(); // TODO: Change the autogenerated stub 
13.     unset($action['index']); 
14.     unset($action['create']); 
15.     unset($action['update']); 
16.     unset($action['delete']); 
17.   } 
18.     
19.   public function actionIndex() 
20.   { 
21.     //你的代码 
22.   } 
23.     
24.   public function actionTest() //假如是get请求 
25.   { 
26.     //业务逻辑 
27.   } 
28.     
29. } 

然后试着访问一下 http://localhost/users/test，报错？找不到？

报错就对了，那是因为我们没有设置其他路由访问

修改 apiconfigmain.php

1. 'urlManager' => [ 
2.   'enablePrettyUrl' => true, 
3.   'enableStrictParsing' => true, 
4.   'showScriptName' => false, 
5.   'rules' => [ 
6.     ['class' => 'yii\rest\UrlRule',  
7.     'controller' => 'user', 
8.     //'pluralize' => false,  //设置为false 就可以去掉复数形式了 
9.     'extraPatterns'=>[ 
10.       'GET send-email'=>'test' 
11.     ], 
12.     ], 
13.   ], 
14. ] 

接下来重新访问就没有问题了，ps：你自己编写的任何 action 都要在 extraPatterns 进行配置。

Tags: Yii2 0基础配置 API基础配置

分享到：