LaravelCode 2018-01-26 13:52:08 40845次浏览 29条评论 42 16 0

Yii2 RESTful API 实战教程

这篇说下yii2.0开发 API 吧,使用 RESTful API模式

安装Yii2.0

通过 Composer 安装

这是安装Yii2.0的首选方法。如果你还没有安装 Composer,你可以按照这里的说明进行安装。

安装完 Composer,运行下面的命令来安装 Composer Asset 插件:

php composer.phar global require "fxp/composer-asset-plugin:^1.2.0"

安装高级的应用程序模板,运行下面的命令:

php composer.phar create-project yiisoft/yii2-app-advanced advanced 2.0.13

初始化高级模板

cd advanced
init

修改数据库连接属性

打开 common\config\main-local.php,配置数据库连接信息

'db' => [
            'class' => 'yii\db\Connection',
            'dsn' => 'mysql:host=127.0.0.1;dbname=yiiapi',
            'username' => 'root',
            'password' => 'root',
            'charset' => 'utf8',
        ],

执行 migrate 数据库迁移

yii migrate

拷贝backend目录,命名为api

打开api\config\main.php 修改id,controllerNamespace

return [
    'id' => 'app-api',
    'basePath' => dirname(__DIR__),
    'controllerNamespace' => 'api\controllers',
]

打开common\config\main.php开启url路由美化规则

'urlManager' => [
            'enablePrettyUrl' => true,
            'showScriptName' => false,
            'rules' => [
            ],
        ],

打开common\config\bootstrap.php添加以下别名

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

为什么要单独创建API应用

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

  • 配置的冲突
  • 控制器的命名不便
  • url美化规则冲突
  • 分工明确frontend为前台目录;backend为后台目录;api为api目录

接下来打开 api\controllers 新建一个User控制器,继承 yii\rest\ActiveController,命名为 UserController,代码如下:

<?php
namespace api\controllers;
use yii\rest\ActiveController;

class UserController extend extends ActiveController
{
    public $modelClass = 'common\models\User';
    
}

这里创建 user控制器继承 yii\rest\ActiveController 并指定要操作的模型

启用JSON 输入

配置 request 应用程序组件的 parsers 属性使用 yii\web\JsonParser 用于 JSON 输入

打开配置文件 api\config\main-local.php 修改为如下代码:

<?php

$config = [
    'components' => [
        'request' => [
            // !!! insert a secret key in the following (if it is empty) - this is required by cookie validation
            'cookieValidationKey' => 'P0r2XoT9LCUnyVlSgxBbJOqQxdCJ3i29',
            'parsers' => [
                'application/json' => 'yii\web\JsonParser',

            ],
        ],
    ],
];

if (!YII_ENV_TEST) {
    // configuration adjustments for 'dev' environment
    $config['bootstrap'][] = 'debug';
    $config['modules']['debug'] = [
        'class' => 'yii\debug\Module',
    ];

    $config['bootstrap'][] = 'gii';
    $config['modules']['gii'] = [
        'class' => 'yii\gii\Module',
    ];
}

return $config;

配置URL规则

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

打开 api\config\main.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 这种方式来进行访问,好吧,可以,满足你,只是不推荐

继续打开配置文件api\config\main.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 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()
    {
        //你的代码
    }
    
    public function actionSendEmail()  //假如是get请求
    {
        //业务逻辑
    }
    
}

然后试着访问一下 http://localhost/users/send-email,报错?找不到?

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

修改 api\config\main.php

'urlManager' => [
    'enablePrettyUrl' => true,
    'enableStrictParsing' => true,
    'showScriptName' => false,
    'rules' => [
        ['class' => 'yii\rest\UrlRule', 
        'controller' => 'user',
        //'pluralize' => false,    //设置为false 就可以去掉复数形式了
        'extraPatterns'=>[
            'GET send-email'=>'send-email'
        ],
        ],
    ],
]

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

差点忘了 状态码 这个东西,我们现在所有的东西返回来的都是一个 JSON,加入没有数据局返回的是空的数组,所以这肯定不行啊,我们得加上 一些特定的状态码 来标识这些数据啊,怎么加?

继续修改 api\config\main.phpcomponents 添加如下代码:

'response' => [
            'class' => 'yii\web\Response',
            'on beforeSend' => function ($event) {
                $response = $event->sender;
                $response->data = [
                    'success' => $response->isSuccessful,
                    'code' => $response->getStatusCode(),
                    'message' => $response->statusText,
                    'data' => $response->data,
                ];
                $response->statusCode = 200;
            },
        ],

这里统一使用 200来表示,当然并不是所有的都是 200,你应该具体情况具体对待,切记不要乱使用 任意加各种标识,有时候你可能需要和一些前端讲道理了 所以请让他们务必 遵循这些 规范 状态码

是不是觉得还少了点什么?认证 对就是 认证,就差 认证 就完美了,篇幅有限,内容多了反而影响阅读兴趣,下篇进行 认证介绍

感谢以下,特别是 魏曦老师的视频教程

魏曦教你学

Yii Framework 2.0 权威指南

不足之处,欢迎指正

觉得很赞
  • 评论于 2019-01-10 09:28 举报

    1.png

    7 条回复
    评论于 2019-01-10 09:36 回复

    我觉得很好排查,你看下控制台网络里的响应

    评论于 2019-01-10 09:37 回复

    你没有初始化吧? 你看下api/web里面有index.php吗?

    评论于 2019-01-10 09:47 回复

    响应里面也是一片空白

    评论于 2019-01-10 09:47 回复

    初始化了,有index.php的

    评论于 2019-01-10 09:50 回复

    首先我不推荐你直接使用浏览器,换一个接口调试工具,

    评论于 2019-01-10 10:02 回复

    谢谢大神,我这边用了接口工具,就正常了

    评论于 2019-01-10 10:06 回复

    对,使用接口调试工具进行调试,不要用浏览器

  • 评论于 2019-01-15 10:44 举报

    public $modelClass = 'common\models\User';
    我这里加不加都不影响结果 为什么

    2 条回复
    评论于 2019-01-15 15:42 回复

    应该是你的控制器继承错了 你的控制器可能是yii\rest\Controller,

    评论于 2019-01-15 15:44 回复

    你换成yii\rest\ActiveController, 如果不加 $modelClass 应该就会报错了

  • 评论于 2020-01-03 10:06 举报

    去掉复数化,不推荐。 这句话怎么理解?

    1. 实际开发的时候,会这么做吗?
    2. 如果默认yii的配置的话,是不是要把项目所有的接口都尽量用index, create, update, delete4种操作来表示?
    3. 涉及到多表的操作怎么处理?假设用户接口,创建的时候,同时生成一条用户信息记录(用户信息表),这种如何处理?如果不自定义action的话,直接到User模型在afterSave里面处理?或者对User模型增加事件?
    3 条回复
    评论于 2020-01-03 15:45 回复

    看你的项目需求了,默认肯定不能满足你的业务啊

    本身 restful 就是在操作资源 ,理解下什么是 restful 就行

    你可以看看 阮一峰老师 的这篇文章 https://www.ruanyifeng.com/blog/2011/09/restful.html

    评论于 2020-01-03 15:47 回复

    具体得按照业务来 ,没必要 完全依照 这个,正常的业务肯定是 多表关联,具体你还得细化 service 层, dao 层之类

    评论于 2020-01-03 17:19 回复

    好的。谢谢回复。

  • 评论于 2020-11-06 10:55 举报

    http://www.api.com/v1/user 只能获取所有表的数据 后边加上s 就404,http://www.api.com/v1/users/1 也404 无法增删该查 是为啥呢

    6 条回复
    评论于 2020-11-06 11:08 回复

    那你是否 把复数模式关掉了呢?关掉的话就不用加 s 了

    评论于 2020-11-06 11:09 回复

    现在的问题 是 增删查改不了 后面加参数就报404,不知道何从下手

    评论于 2020-11-06 11:11 回复

    按照教程走了吗?贴出你的代码

    评论于 2020-11-06 11:11 回复

    而且我没关他复数形式 只能获取个所有列表其他都404

    评论于 2020-11-06 11:14 回复

    我知道了,那是因为我的教程去掉了 其他的 action ,只重写了 index

    unset($action['index']);
    unset($action['create']);
    unset($action['update']);
    unset($action['delete']);
    

    如果 Yii 自身的能满足需要,那么就不要上面的代码。否则 就需要重写 每个 action 处理你自己的业务。

    评论于 2020-11-06 11:16 回复

    如果 本身的不能满足业务需求 ,就需要重写他的方法,你重新添加 其他action 即可,和 actionIndex() 一样

  • 评论于 2020-11-06 11:21 举报

    微信图片_20201106111845.png
    1.png
    7.png

  • 评论于 2020-11-06 11:24 举报

    9.png

    2 条回复
    评论于 2020-11-06 11:28 回复

    你加我微信吧 ,备注 YiiChina

    评论于 2020-11-06 11:31 回复

    760963254 害 忘记发微信号了....

  • 评论于 2021-10-13 11:01 举报
    return [
        'id' => 'app-api',
        'basePath' => dirname(__DIR__),
        'controllerNamespace' => 'api\controllers',
        'bootstrap' => ['log'],
        'modules' => [],
        'components' => [
            'request' => [
                'csrfParam' => '_csrf-backend',
            ],
            'user' => [
                'identityClass' => 'common\models\User',
                'enableAutoLogin' => true,
                'identityCookie' => ['name' => '_identity-backend', 'httpOnly' => true],
            ],
            'session' => [
                // this is the name of the session cookie used for login on the backend
                'name' => 'advanced-backend',
            ],
            'log' => [
                'traceLevel' => YII_DEBUG ? 3 : 0,
                'targets' => [
                    [
                        'class' => 'yii\log\FileTarget',
                        'levels' => ['error', 'warning'],
                    ],
                ],
            ],
            'errorHandler' => [
                'errorAction' => 'site/error',
            ],
            /*
            'urlManager' => [
                'enablePrettyUrl' => true,
                'showScriptName' => false,
                'rules' => [
                ],
            ],
            */
        ],
        'params' => $params,
    ];
    

    这里后面还有几个 backend,不知道需要同步更改吗?或者说让 api backend 他们用同一套规则

    1 条回复
    评论于 2021-10-13 11:34 回复

    改不改都行,建议分开,不使用同一套规则

  • 评论于 2021-10-15 09:26 举报

    亲测去掉 common/config 下的 main-local.php 中的 urlManager 其他按照大神的教程,完全能实现

    1 条回复
    评论于 2021-10-15 09:37 回复

    哈哈哈哈,感谢感谢

  • 评论于 2021-10-27 18:35 举报

    'enablePrettyUrl' => true,为什么我打开这个就用不了

    5 条回复
    评论于 2021-10-28 09:46 回复

    检查下是否位置写错了?具体的报错信息是什么?

    评论于 2021-10-28 14:52 回复

    报错404,只要开启url美化就报错404,http://localhost/web/index.php , localhost指向frontend文件,注释掉//'enablePrettyUrl' => true,就能访问,我apache和nginx能切换使用,但是都不行.

    评论于 2021-10-28 16:49 回复

    额,你检查下你的index.php 是不是做了隐藏,去掉index.php

    评论于 2021-10-29 10:40 回复

    谢谢大哥,可以啦。是这个.htaccess文件的问题,网上好多.htaccess我用了都不合适。

您需要登录后才可以评论。登录 | 立即注册