Yii2.0 RESTful API 基础配置教程详解


Posted in PHP onDecember 26, 2018

最近在做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 进行配置

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

PHP 相关文章推荐
PHP中函数内引用全局变量的方法
Oct 20 PHP
php 5.3.5安装memcache注意事项小结
Apr 12 PHP
PHP全概率运算函数(优化版) Webgame开发必备
Jul 04 PHP
thinkphp验证码显示不出来的解决方法
Mar 29 PHP
smarty简单分页的实现方法
Oct 27 PHP
PHPExcel简单读取excel文件示例
May 26 PHP
php+ajax登录跳转登录实现思路
Jul 31 PHP
php+jQuery递归调用POST循环请求示例
Oct 14 PHP
php使用str_replace替换多维数组的实现方法分析
Jun 15 PHP
Laravel框架实现调用百度翻译API功能示例
May 30 PHP
php操作redis数据库常见方法实例总结
Feb 20 PHP
gearman中任务的优先级和返回状态实例分析
Feb 27 PHP
CI框架实现创建自定义类库的方法
Dec 25 #PHP
PHP中soap用法示例【SoapServer服务端与SoapClient客户端编写】
Dec 25 #PHP
PHP使用SOAP调用API操作示例
Dec 25 #PHP
详解PHP实现支付宝小程序用户授权的工具类
Dec 25 #PHP
PHP正则匹配到2个字符串之间的内容方法
Dec 24 #PHP
PHP基于PDO扩展操作mysql数据库示例
Dec 24 #PHP
PHP封装的page分页类定义与用法完整示例
Dec 24 #PHP
You might like
windows xp下安装pear
2006/12/02 PHP
PHP如何编写易读的代码
2007/07/10 PHP
php实现Session存储到Redis
2015/11/11 PHP
php中的常用魔术方法汇总
2016/02/14 PHP
thinkPHP5.0框架命名空间详解
2017/03/18 PHP
PHP单文件上传原理及上传函数的封装操作示例
2019/09/02 PHP
Javascript 判断函数类型完美解决方案
2009/09/02 Javascript
JavaScript判断密码强度(自写代码)
2013/09/06 Javascript
jquery制作漂亮的弹出层提示消息特效
2014/12/23 Javascript
jQuery验证元素是否为空的两种常用方法
2015/03/17 Javascript
js实现类似jquery里animate动画效果的方法
2015/04/10 Javascript
javascript日期操作详解(脚本之家整理)
2015/09/05 Javascript
bootstarp modal框居中显示的实现代码
2017/02/18 Javascript
JS实现中国公民身份证号码有效性验证
2017/02/20 Javascript
jQuery使用DataTable实现删除数据后重新加载功能
2017/02/27 Javascript
深入浅析Nodejs的Http模块
2017/06/20 NodeJs
浅谈JavaScript面向对象--继承
2019/03/20 Javascript
nodejs中使用archive压缩文件的实现代码
2019/11/26 NodeJs
使用python实现baidu hi自动登录的代码
2013/02/10 Python
用python + openpyxl处理excel2007文档思路以及心得
2014/07/14 Python
python 返回列表中某个值的索引方法
2018/11/07 Python
python3中property使用方法详解
2019/04/23 Python
python字典的常用方法总结
2019/07/31 Python
Python如何实现小程序 无限求和平均
2020/02/18 Python
Python爬取365好书中小说代码实例
2020/02/28 Python
利用scikitlearn画ROC曲线实例
2020/07/02 Python
Matlab使用Plot函数实现数据动态显示方法总结
2021/02/25 Python
安全的后院和健身蹦床:JumpSport
2019/07/15 全球购物
俄罗斯护发和专业化妆品购物网站:Hihair
2019/09/28 全球购物
就业自荐信
2013/12/04 职场文书
土建资料员岗位职责
2014/01/04 职场文书
会计人员岗位职责
2014/03/19 职场文书
爱岗敬业事迹材料
2014/12/24 职场文书
2015年财务人员个人工作总结
2015/07/27 职场文书
基于tensorflow权重文件的解读
2021/05/26 Python
SQL Server Agent 服务无法启动
2022/04/20 SQL Server