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

 更新时间:2018年12月26日 08:32:48   作者:hedeqiang   我要评论

这篇文章主要介绍了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"后会出现以下内容

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开发中常用的十个代码样例

    本文是小编日常收集整理的有关php开发中常用的十个代码样例,非常不错,特此分享供大家参考
    2016-02-02
  • Codeigniter生成Excel文档的简单方法

    Codeigniter生成Excel文档的简单方法

    之前看了使用PHPExcel中导出数据到Excel文件的方法,但是似乎比较复杂。icech找到了一个针对Codeigniter的类:CI-Excel-Generation-Library,使用方法十分简单。需要的朋友可以参考下
    2014-06-06
  • 浅析php创建者模式

    浅析php创建者模式

    本文通过实例向我们展示了php设计模式中的创建者模式,及创建者模式所应用的场景,这里推荐给大家。
    2014-11-11
  • php写app接口并返回json数据的实例(分享)

    php写app接口并返回json数据的实例(分享)

    下面小编就为大家带来一篇php写app接口并返回json数据的实例(分享)。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-05-05
  • 2017年最好用的9个php开发工具推荐(超好用)

    2017年最好用的9个php开发工具推荐(超好用)

    对于php初学者不知道哪个php开发工具好用,下面小编给大家分享2017年最好用的9个php开发工具推荐,感兴趣的朋友一起看看吧
    2017-10-10
  • thinkphp的静态缓存用法分析

    thinkphp的静态缓存用法分析

    这篇文章主要介绍了thinkphp的静态缓存用法,较为详细的分析了静态缓存的配置方法与相关操作的技巧,具有一定的实用价值,需要的朋友可以参考下
    2014-11-11
  • CI框架学习笔记(一) - 环境安装、基本术语和框架流程

    CI框架学习笔记(一) - 环境安装、基本术语和框架流程

    本文是CI框架学习笔记的第一篇,主要介绍了CI框架的环境安装,基本术语以及框架流程,非常的详细,有需要的朋友可以参考下
    2014-10-10
  • Laravel框架定时任务2种实现方式示例

    Laravel框架定时任务2种实现方式示例

    这篇文章主要介绍了Laravel框架定时任务2种实现方式,结合实例形式较为详细的分析了Laravel框架定时任务相关实现方法及操作注意事项,需要的朋友可以参考下
    2018-12-12
  • Yii实现显示静态页的方法

    Yii实现显示静态页的方法

    这篇文章主要介绍了Yii实现显示静态页的方法,结合实例形式分析了Yii框架显示静态页的步骤与相关实现技巧,需要的朋友可以参考下
    2016-04-04
  • thinkphp3.x中session方法的用法分析

    thinkphp3.x中session方法的用法分析

    这篇文章主要介绍了thinkphp3.x中session方法,全面分析了thinkPHP中session的初始化、设置、赋值、删除、管理等各种常用操作技巧,需要的朋友可以参考下
    2016-05-05

最新评论