共计 3843 个字符，预计需要花费 10 分钟才能阅读完成。
最近在做 Yii2.0 RESTful API 功能，找了好久的资料，才找到这类的教程，感谢该作者，以下内容根据我的项目实际情况做了一定的修改。
安装 yii2.0
安装 Composer 后，您可以通过在 Web 可访问的文件夹下运行以下命令来 安装 Yii 应用程序模板：
composer create-project –prefer-dist yiisoft/yii2-app-basic basic
初始化高级模板
cd advanced
./init
输入 ”./init” 后会出现以下内容
Yii Application Initialization Tool v1.0
Which environment do you want the application to be initialized in?
[0] Development
[1] Production
Your choice [0-1, or “q” to quit] 0
Initialize the application under ‘Development’ environment? [yes|no] yes
Start initialization …
修改数据库连接属性
打开 commonconfigmain-local.php, 配置数据库连接信息
‘db’ => [
‘class’ => ‘yii\db\Connection’,
‘dsn’ => ‘mysql:host=127.0.0.1;dbname=yii’,
‘username’ => ‘root’,
‘password’ => ‘root’,
‘charset’ => ‘utf8’,
],
执行 migrate 数据库迁移
./yii migrate
拷贝 backend 目录，命名为 api
打开 apiconfigmain.php 修改 id,controllerNamespace 等，将所有 backend 替换为 api：
return [
‘id’ => ‘app-api’,
‘basePath’ => dirname(__DIR__),
‘controllerNamespace’ => ‘api\controllers’,
]
打开 apiconfigmain.php 开启 url 路由美化规则
‘urlManager’ => [
‘enablePrettyUrl’ => true,
‘showScriptName’ => false,
‘rules’ => [
],
],
打开 commonconfigbootstrap.php 添加以下别名
Yii::setAlias(‘@api’, dirname(dirname(__DIR__)) . ‘/api’);
为什么要单独创建 API 应用
单独创建 API 应用，目的是便于维护，可以避免以下问题
配置的冲突
控制器的命名不便
url 美化规则冲突
分工明确 frontend 为前台目录；backend 为后台目录；api 为 api 目录
接下来打开 apicontrollers 新建一个 User 控制器，继承 yiirestActiveController，命名为 UserController, 代码如下：
<?php
namespace api\controllers;
use yii\rest\ActiveController;
class UserController extends ActiveController
{
public $modelClass = ‘common\models\User’;
}
配置 URL 规则
为刚才的 user 控制器添加 url 美化规则打开 apiconfigmain.php 修改 components 属性，添加下列代码:
…
‘urlManager’ => [
‘enablePrettyUrl’ => true,
‘enableStrictParsing’ => true,
‘showScriptName’ => false,
‘rules’ => [
[‘class’ => ‘yii\rest\UrlRule’,
‘controller’ => ‘user’
],
],
]
…
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” “http://localhost/users”
命令行下还是比较麻烦的，也不方便测试，推荐使用 API 测试工具
这类的工具有很多，我就不一一列举了，这里推荐 Postman, 很好很强大，Chorme 也有插件，可以安装，这里我推荐直接下载软件安装调试，比较方便
你可能发现了 访问任何路由地址都是加的 s,users，为什么呢? 资源，你要理解 资源二字，既然是资源肯定是个集合，肯定有一大堆，所以要加上复数，我是这么理解的。
你说我就是不想加上 s, 我就想采用 http://localhost/user 这种方式来进行访问，好吧，可以，满足你，只是不推荐
继续打开配置文件 apiconfigmain.php 修改刚才添加的 urlManager 如下:
‘urlManager’ => [
‘enablePrettyUrl’ => true,
‘enableStrictParsing’ => true,
‘showScriptName’ => false,
‘rules’ => [
[‘class’ => ‘yii\rest\UrlRule’,
‘controller’ => ‘user’,
‘pluralize’ => false, // 设置为 false 就可以去掉复数形式了
],
],
]
加入 ‘pluralize’ => false, 就表示去掉复数形式了，再次强调不推荐
ok，在控制器中我们没有写任何一句代码，他就给我们生成许多方法，但是有时候我们可能需要修改一些代码，来达到我们想要的效果，比如连表查询，然后再返回数据
接下来我们就实现这样的功能:
打开刚才新建的 user 控制器, 重写 action 方法:
<?php
namespace api\controllers;
use yii\rest\ActiveController;
class UserController extend extends ActiveController
{
public $modelClass = ‘common\models\User’;
public function actions()
{
$action= parent::actions(); // TODO: Change the autogenerated stub
unset($action[‘index’]);
unset($action[‘create’]);
unset($action[‘update’]);
unset($action[‘delete’]);
}
public function actionIndex()
{
// 你的代码
}
}
这样我们就可以重写他的代码了。哈哈
我们再新建一个自己的 action
<?php
namespace api\controllers;
use yii\rest\ActiveController;
class UserController extends ActiveController
{
public $modelClass = ‘common\models\User’;
public function actions()
{
$action= parent::actions(); // TODO: Change the autogenerated stub
unset($action[‘index’]);
unset($action[‘create’]);
unset($action[‘update’]);
unset($action[‘delete’]);
}
public function actionIndex()
{
// 你的代码
}
public function actionTest() // 假如是 get 请求
{
// 业务逻辑
}
}
然后试着访问一下 http://localhost/users/test，报错？找不到？
报错就对了，那是因为我们没有设置其他路由访问
修改 apiconfigmain.php
‘urlManager’ => [
‘enablePrettyUrl’ => true,
‘enableStrictParsing’ => true,
‘showScriptName’ => false,
‘rules’ => [
[‘class’ => ‘yii\rest\UrlRule’,
‘controller’ => ‘user’,
//’pluralize’ => false, // 设置为 false 就可以去掉复数形式了
‘extraPatterns’=>[
‘GET send-email’=>’test’
],
],
],
]
接下来重新访问就没有问题了，ps：你自己编写的任何 action 都要在 extraPatterns 进行配置
再次感谢以下：
https://segmentfault.com/a/11…