欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

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

程序员文章站 2022-07-06 12:49:55
最近在做yii2.0 restful api功能,找了好久的资料,才找到这类的教程,感谢该作者,以下内容根据我的项目实际情况做了一定的修改。 安装yii2.0 安装...

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

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