yii2 restful api——app接口编程实例

<?php

namespace common\components;

use common\models\Cart;
use common\models\User;
use Yii;
use yii\rest\Controller;
use yii\web\Response;

class ETRestController extends Controller
{
    /**
     * api返回的json
     * @param $status
     * @param $code
     * @param $message
     * @param $data
     * @param array $share
     * @return string
     * @apiVersion 1.0
     */
    protected function jsonEncode($status, $data=[], $message='', $code=1, $share=[])
    {
        $status     = boolval($status);
        $data       = $data ? $data : (object)array();
        $message    = strval($message);
        $code       = intval($code);
        $share      = $share ? $share : (object)array();

        $result = [
            'status'     => $status,
            'code' => $code,
            'message'    => $message,
            'data'       => $data,
            'share'      => $share,
        ];

        //设置响应对象
        $response = Yii::$app->response;
        $response->format = Response::FORMAT_JSON;
        $response->data = $result;
    }

    protected function jsonSuccess($data=[], $message='', $code=1, $share=array())
    {
        $message = $message ? $message : '调用成功';
        $this->jsonEncode(true, $data, $message, $code, $share);
    }

    protected function jsonFail($data=array(), $message='', $code=0, $share=array())
    {
        $message = $message ? $message : '调用失败';
        $this->jsonEncode(false, $data, $message, $code, $share);
    }

    protected function isLoggedIn()
    {
        $user = User::findIdentityByAccessToken(@$_REQUEST['access_token']);
        return !!$user;
    }

    protected function getUserId()
    {
        $user = User::findIdentityByAccessToken(@$_REQUEST['access_token']);
        return $user ? $user->id : null;
    }

    protected function getUser()
    {
        return User::findIdentityByAccessToken(@$_REQUEST['access_token']);
    }

    protected function getAppCartCookieId()
    {
        return $this->getParam('app_cart_cookie_id') ? $this->getParam('app_cart_cookie_id') : Cart::genAppCartCookieId();
    }

    /**
     * 获取 $_REQUEST[$name], 包含get,post方式传过来的值
     * @param $name
     * @param null $defaultValue
     * @return mixed
     */
    protected function getParam($name, $defaultValue=null)
    {
        return isset($_REQUEST[$name]) ? $_REQUEST[$name] : $defaultValue;
    }
}

<?php


namespace api\modules\v1\controllers;

use common\models\Address;
use common\models\Area;
use Yii;
use common\components\ETRestController;

/**
 * 用户收货地址控制器
 * Class AddressController
 * @package api\modules\v1\controllers
 */
class AddressController extends ETRestController
{
    /**
     * 地址列表
     */
    public function actionIndex()
    {
        if(!$this->isLoggedIn()){
            return $this->jsonFail([], '您还没有登录');
        }

        $user_id = $this->getUserId();
        $addresses = Address::findByUser($user_id);
        $addressesArr = [];
        foreach($addresses as $address){
            $addrArr = $address->toArray([], ['area']);
            $addrArr['area']['path_names_4print'] = $address->area->getPathNames4Print();
            $addressesArr[] = $addrArr;
        }

        $data = [
            'addresses' => $addressesArr,
        ];
        return $this->jsonSuccess($data);
    }

    /**
     * 添加地址
     */
    public function actionCreate()
    {
        if(!$this->isLoggedIn()){
            return $this->jsonFail([], '您还没有登录');
        }

        $user_id = $this->getUserId();
//        $area_id = $this->getParam('area_id');
//        $telephone = $this->getParam('telephone');
//        $detail = $this->getParam('detail');
//        $fullname = $this->getParam('fullname');
//
//        //字段验证, 不能用
//        if(empty($area_id)){
//
//        }
//
//        //字段必须填写验证
//        if (StringUtils.isBlank(areaId)) {
//            result = false;
//            message = "区域地址areaId(:" + areaId + ") 不能为空";
//            return renderString(response, result, message, data);
//        }
//        if (StringUtils.isBlank(fullname)) {
//            result = false;
//            message = "请填写收货人姓名，用于收货";
//            return renderString(response, result, message, data);
//        }
//        if (StringUtils.isBlank(telephone)) {
//            result = false;
//            message = "请填写手机号码，用于收货";
//            return renderString(response, result, message, data);
//        }
//        if (!ValidateUtils.isMobile(telephone)) {
//            result = false;
//            message = ValidateUtils.getErrMsg();
//            return renderString(response, result, message, data);
//        }

        $area_id = $this->getParam('area_id');
        $area = Area::findOne($area_id);
        if (!$area) {
            return $this->jsonFail("区域地址(ID:$area_id) 不存在");
        }

        //非店内消费必须填写门牌地址
        if ($area->id != Area::SHIPPING_GROUP_STORE && empty($this->getParam('detail'))) {
            return $this->jsonFail([], '请填写门牌地址，用于收货');
        }

        //清除默认地址, 因为把每次添加的地址作为默认地址
        Address::updateAll(['is_default'=>Address::NO], 'user_id=:user_id', [':user_id'=>$user_id]);

        //添加收货地址
        $address = new Address();
        $addressData = $_REQUEST;
        $addressData['is_default'] = Address::YES;
        $addressData['user_id'] = $user_id;
        if(!($address->load($addressData, '') && $address->save())) {
            return $this->jsonFail([], $address->errorsToString());
        }

        //我的收货列表
        $addresses = Address::findByUser($user_id);
        $addressesArr = [];
        foreach($addresses as $item){
            $addressesArr[] = $item->toArray([], ['area']);
        }

        //带有区域对象的新地址
        $addrArr = [];
        $addrArr[] = $address->toArray();
        $addrArr['area'] = $address->area->toArray();
        $addrArr['area']['path_names_4print'] = $address->area->getPathNames4Print();

        $data = [
            'addresses' => $addressesArr,
            'address' => $addrArr,
        ];
        return $this->jsonSuccess($data);
    }

    public function delete()
    {
        if(!$this->isLoggedIn()){
            return $this->jsonFail([], '您还没有登录');
        }

        $id = $this->getParam('id');
    }
}

<?php


namespace api\modules\v1\controllers;

use common\components\ETRestController;
use common\models\Cart;
use common\models\CartItem;
use common\models\User;
use yii\filters\auth\CompositeAuth;
use yii\filters\auth\HttpBasicAuth;
use yii\filters\auth\HttpBearerAuth;
use yii\filters\auth\QueryParamAuth;
use yii\helpers\ArrayHelper;
use yii\validators\Validator;

class UserController extends ETRestController
{
    /**
    * 行为: 登录认证
    * @return array
    */
   public function behaviors()
   {
      return ArrayHelper::merge(parent::behaviors(), [
         'authenticator' => [
                #这个地方使用`ComopositeAuth` 混合认证
              'class' => CompositeAuth::className(),
               #`authMethods` 中的每一个元素都应该是 一种 认证方式的类或者一个 配置数组
             'authMethods' => [
                   //HttpBasicAuth::className(),
                 //HttpBearerAuth::className(),
                  QueryParamAuth::className(), //url as: http://api.eleteam.com/v1/users?access-token=123
               ]
        ]
     ]);
   }

    public function actionView()
    {
        $user = $this->getUser();
        $userArr = [];
        $user && $userArr = $user->toArray();
        $userArr['level_label'] = '铜牌用户';
        $data = [
            'user' => $userArr,
            'user_id' => $this->getUserId(),
        ];
        return $this->jsonSuccess($data);
    }

    /**
     * 注册第一步 - 提交手机号码
     * @return string
     */
    public function actionRegisterStep1()
    {
        $mobile = $this->getParam('mobile');
        if(strlen($mobile)<11){
            return $this->jsonFail([], '手机号格式不正确');
        }

        $user = User::findOneByMobile($mobile, null);
        if($user){
            return $this->jsonFail([], '手机号已存在');
        }

        //发送手机验证码
        //SmsUtils.sendRegisterCode(username);

        return $this->jsonSuccess(['mobile'=>$mobile]);
    }

    /**
     * 注册第二步 - 提交手机号码、密码
     * @return string
     */
    public function actionRegisterStep2()
    {
        $mobile = $this->getParam('mobile');
        $password = $this->getParam('password');
        if(strlen($mobile)<11){
            return $this->jsonFail([], '手机号格式不正确');
        }

        $user = User::findOneByMobile($mobile, null);
        if($user){
            return $this->jsonFail([], '手机号已存在');
        }

        //发送手机验证码
        //SmsUtils.sendRegisterCode(username);

        return $this->jsonSuccess(['mobile'=>$mobile, 'password'=>$password]);
    }

    /**
     * 注册完成 - 提交手机号码、密码、验证码
     * @return string
     */
    public function actionRegisterStep3()
    {
        $mobile = $this->getParam('mobile');
        $password = $this->getParam('password');
        $code = $this->getParam('code');
        if(strlen($mobile)<11){
            return $this->jsonFail([], '手机号格式不正确');
        }

        $user = User::findOneByMobile($mobile, null);
        if($user){
            return $this->jsonFail([], '手机号已存在');
        }

        if(strlen($password) < 6){
            return $this->jsonFail([], '密码必须大于6位');
        }

        //比较验证码
        //if (smsService.checkRegisterCode(username, code)) {
        //短信验证码已过期，现在固定用 "8888"
        if($code != '8888'){
            return $this->jsonFail([], '验证码不正确');
        }

        //创建用户
        $user = new User();
        $user->mobile = $mobile;
        $user->password_plain = $password;
        $user->setPassword($password);
        $user->generateAccessToken();
        if($user->save()){
            $app_cart_cookie_id = $this->getAppCartCookieId();
            $user_id = $user->id;

            //给新注册用户发送优惠券
            //couponUserService.send4NewUser(loginUser.getId());

            //转移购物车给用户
            if($app_cart_cookie_id) {
                $cart = Cart::findOneByAppCartCookieId($app_cart_cookie_id);
                if(!$cart){ //创建购物车
                    $cart = new Cart();
                    $cart->user_id = $user_id;
                    $cart->save();
                }else{ //转移购物车项给用户
                    Cart::updateAll(['user_id'=>$user_id], 'app_cart_cookie_id=:app_cart_cookie_id', ['app_cart_cookie_id' => $app_cart_cookie_id]);
                    CartItem::updateAll(['user_id'=>$user_id], 'app_cart_cookie_id=:app_cart_cookie_id', ['app_cart_cookie_id' => $app_cart_cookie_id]);
                }
            }

            $data = [
                'user' => $user->toArray(),
                'app_cart_cookie_id' => Cart::genAppCartCookieId(), //重新生成保存在前端, 当没登陆时用新的购物车
            ];
            return $this->jsonSuccess($data);
        }

        return $this->jsonFail(['user'=>$user->toArray()], '注册用户失败');
    }

    /**
     * 直接注册 - 提交手机号码、密码、验证码
     * @return string
     */
    public function actionRegister()
    {
        $mobile = $this->getParam('mobile');
        $password = $this->getParam('password');
        $code = $this->getParam('code');
        if(strlen($mobile) != 11){
            return $this->jsonFail([], '手机号格式不正确');
        }

        $user = User::findOneByMobile($mobile, null);
        if($user){
            return $this->jsonFail([], '手机号已存在');
        }

        if(strlen($password) < 6){
            return $this->jsonFail([], '密码必须大于6位');
        }

        //比较验证码
        //if (smsService.checkRegisterCode(username, code)) {
        //短信验证码已过期，现在固定用 "8888"
        if($code != '8888'){
            return $this->jsonFail([], '验证码不正确');
        }

        //创建用户
        $user = new User();
        $user->mobile = $mobile;
        $user->password_plain = $password;
        $user->setPassword($password);
        $user->generateAccessToken();
        if($user->save()){
            $app_cart_cookie_id = $this->getAppCartCookieId();
            $user_id = $user->id;

            //给新注册用户发送优惠券
            //couponUserService.send4NewUser(loginUser.getId());

            //转移购物车给用户
            if($app_cart_cookie_id) {
                $cart = Cart::findOneByAppCartCookieId($app_cart_cookie_id);
                if(!$cart){ //创建购物车
                    $cart = new Cart();
                    $cart->user_id = $user_id;
                    $cart->save();
                }else{ //转移购物车项给用户
                    Cart::updateAll(['user_id'=>$user_id], 'app_cart_cookie_id=:app_cart_cookie_id', ['app_cart_cookie_id' => $app_cart_cookie_id]);
                    CartItem::updateAll(['user_id'=>$user_id], 'app_cart_cookie_id=:app_cart_cookie_id', ['app_cart_cookie_id' => $app_cart_cookie_id]);
                }
            }

            $data = [
                'user' => $user->toArray(),
                'app_cart_cookie_id' => Cart::genAppCartCookieId(), //重新生成保存在前端, 当没登陆时用新的购物车
            ];
            return $this->jsonSuccess($data);
        }

        return $this->jsonFail(['user'=>$user->toArray()], '注册用户失败');
    }

    /**
     * 通过手机号码快捷登录
     * @param $mobile
     * @param $code
     * @return string
     */
    public function actionMobileLogin($mobile, $code)
    {
        if(strlen($mobile)<11){
            return $this->jsonFail([], '手机号格式不正确');
        }

        //验证码验证, 未实现 @todo
        if($code != '8888'){
            return $this->jsonFail([], '验证码不正确');
        }

        //手机号存在
        $user = User::findOneByMobile($mobile);

        //如果手机号不存在则创建用户
        if(!$user){
            $user = new User();
            $data = ['User' => ['mobile' => $mobile]];
            if($user->load($data) && $user->save(false)){
                //
            }else{
                return $this->jsonFail($user->errors, '创建用户失败');
            }
        }

        //如果没有access_token,则创建
        $user->access_token = $user->getAccessToken();
        return $this->jsonSuccess(['user'=>$user->toArray()], '登录成功');
    }

    /**
     * api登录, 返回access-token值
     *  购物车商品的保存方式:
     *      1. 没有登陆且购物车有值, 以当前购物车为准
     *      2. 没有登陆且购物车没值, 以用户的购物车为准
     * post: [mobile:123, password=abc]
     * @return LoginForm|string
     */
    public function actionLogin()
    {
        $mobile = $this->getParam('mobile');
        $password = $this->getParam('password');
        $app_cart_cookie_id = $this->getAppCartCookieId();

        if(strlen($mobile) != 11){
            return $this->jsonFail([], '手机号格式不正确');
        }

        if(!strlen($password)){
            return $this->jsonFail([], '请输入密码');
        }

        $user = User::findOneByMobile($mobile);
        if($user && $user->validatePassword($password)){
            $user_id = $user->id;
            $user->getAccessToken();
            //转移购物车给用户
            if($app_cart_cookie_id) {
                $cart = Cart::findOneByAppCartCookieId($app_cart_cookie_id);
                if($cart){
                    $userCart = Cart::myCart($user_id, null);
                    $cartItems = Cart::findItems($cart->id);
                    if($cartItems) {
                        //清空用户的购物车项
                        CartItem::updateAll(['status'=>CartItem::STATUS_DELETED], 'cart_id=:cart_id', ['cart_id'=>$userCart->id]);
                        //转移购物车项给用户
                        CartItem::updateAll(['user_id'=>$user_id, 'cart_id'=>$userCart->id], 'app_cart_cookie_id=:app_cart_cookie_id', ['app_cart_cookie_id' => $app_cart_cookie_id]);
                    }
                }
            }
            $data = [
                'user' => $user->toArray(),
                'app_cart_cookie_id' => Cart::genAppCartCookieId(), //重新生成保存在前端, 当没登陆时用新的购物车
            ];
            return $this->jsonSuccess($data);
        }

        return $this->jsonFail([], '手机号或密码错误');

//        $data = [
//            'username' => $mobile,
//            'password' => $password,
//        ];
//        $model = new LoginForm();
//        if ($model->load($data, '') && $model->login()) {
//            return Yii::$app->user->identity->access_token;
//            return Yii::$app->user->identity->getAuthKey();
//        } else {
//            return $model;
//        }
    }

    /**
     * @param $mobile
     * @return string
     */
    public function actionSendCode($mobile)
    {
        if(strlen($mobile)<11){
            return $this->jsonFail([], '手机号格式不正确');
        }

        $user = User::findOneByMobile($mobile);
        if($user && $user->id){
            return $this->jsonFail([], '手机号已存在');
        }

        //发送手机验证码, 未实现, @todo

        return $this->jsonSuccess([], '验证码已发送');
    }

    /**
     * api退出, 前期退出不更新access-token, 任何平台都可以登录用户的账号,便于调试,而且不会导致用户登录的token失效
     * 后期如果要实现单点登录时,则清空用户的token即可
     * @return bool
     */
    public function actionLogout()
    {
        $app_cart_cookie_id = Cart::genAppCartCookieId(); //重新生成保存在前端, 当没登陆时用新的购物车
        return $this->jsonSuccess(['app_cart_cookie_id'=>$app_cart_cookie_id]);
    }

//    public function actionIsLoggedIn($user_id, $api_login_token)
//    {
//        $result = ['is_logged_in' => false];
//        $user = User::findOne($user_id);
//        if($user && $user->api_login_token && $user->api_login_token == $api_login_token){
//            $result['is_logged_in'] = true;
//        }
//        return $result;
//    }
}

什么是RESTful风格的API

对于各种客户端设备与服务端的通信，我们往往都通过API为客户端提供数据，提供某种资源。关于RESTful的概念，一查一大推，一两句也解释不清，姑且先按照我们通俗的理解：在众多风格、众多原则的API中，RESTful就是一套比较优秀的接口调用方式。

Yii2如何实现RESTful风格的API

1、建立单独的应用程序

为了增加程序的可维护性，易操作性，我们选择新建一套应用程序，这也是为了和前台应用、后台应用区分开操作。有些人要嚷嚷了，为啥非得单独搞一套呢？如果你就单纯的提供个别的几个h5页面的话，那就没有必要了，但事实往往是客户端要升级啊，要增加不同的版本啊，这就需要我们不但要后端不仅要增加一套单独的应用程序，我们还要增加各种版本去控制。

在WEB前端（frontend）和后端（backend）的同级目录，新建一个文件夹，命名api,其目录结构如下所示：

├─assets
│      AppAsset.php
├─config
│      bootstrap.php
│      main-local.php
│      main.php
│      params-local.php
│      params.php
├─runtime
└─web
    │ index.php
    ├─assets
    └─css

可以看出其目录结构基本上同backend没有其他差异，因为我们就是拷贝backend项目，只是做了部分优化。

友情提醒，该步骤完成以后，需要修改common\config\bootstrap.php文件，对新建的应用增加alias别名

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

2、为新建的api应用程序美化路由

首先保证你的web服务器开启rewrite规则，细节我们就不说了，不过这是前提。

接着配置api/config/main.php文件

'components' => [
    // other config
    'urlManager' => [
        'enablePrettyUrl' => true,
        'showScriptName' => false,
        'enableStrictParsing' =>true,
        'rules' => [],
    ]
],

最后只需要在应用入口同级增加.htaccess文件就好，我们以apache为例

Options +FollowSymLinks
IndexIgnore */*

RewriteEngine on

# if a directory or a file exists, use it directly
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d

# otherwise forward it to index.php
RewriteRule . index.php

RewriteRule \.svn\/  /404.html
RewriteRule \.git\/  /404.html

3、利用gii生成测试modules

用了便于演示说明，我们新建一张数据表goods表，并向其中插入几条数据。

CREATE TABLE `goods` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `name` varchar(100) NOT NULL DEFAULT '',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

INSERT INTO `goods` VALUES ('1', '11111');
INSERT INTO `goods` VALUES ('2', '22222');
INSERT INTO `goods` VALUES ('3', '333');
INSERT INTO `goods` VALUES ('4', '444');
INSERT INTO `goods` VALUES ('5', '555');

接着我们先利用gii生成modules后，再利用gii模块，按照下图中生成goods信息

现在，我们的api目录结构应该多个下面这几个目录

│
├─models
│      Goods.php
│
├─modules
│  └─v1
│      │  Module.php
│      │
│      ├─controllers
│      │      DefaultController.php
│      │      GoodsController.php
│      │
│      └─views
│          └─default
│                  index.php

需要说明的是：在生成modules的步骤中，为了使我们的模块可以访问，不要忘记在main.php配置文件中添加下面的代码

<?php    
    ......
    'modules' => [
        'v1' => [
            'class' => 'api\modules\v1\Module',
        ],
    ],
    ......

4、重新配置控制器

为了实现restful风格的api,在yii2中，我们需要对控制器进行一下改写

<?php

namespace api\modules\v1\controllers;

use yii\rest\ActiveController;

class GoodsController extends ActiveController
{
    public $modelClass = 'api\models\Goods';
}

5、为Goods配置Url规则

'rules' => [
    [
        'class' => 'yii\rest\UrlRule',
        'controller' => ['v1/goods']
    ],
]

6、模拟请求操作

经过上面几个步骤，到此我们已经为goods成功创建了满足restful风格的api了。为了更好更方便的演示，我们借助工具postman进行模拟请求。

为了见证一下我们的操作，我们用postman请求一下GET /v1/goods看看结果如何：

从上面截图中可以清楚的看到，GET /v1/goods 已经能够很方便的获取我们表中的数据了。

当然，yii2还对该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 支持的动词

不信的话我们可以利用postman发送一个post请求到/v1/goods,我们会发现成功创建了一个新的商品。

需要提醒的是，操作中还请细心且注意：

如果你的控制器末端不是复数（比如是blog非blogs）请保证请求的时候是复数！这是因为在RESTful架构中，网址中只能有名词而不能包含动词，名词又往往与数据表相对应，数据表呢又是一个“集合”，因此该名词往往是复数的形式。

7、关于授权认证

为什么需要授权认证？这在一般的操作中是需要的。比如说用户要设置自己的信息。

为了对yii2 restful授权认证说的更清楚，我们将会以两个两种不同的方法进行说明。

首先需要开启认证：

假设我们已经按照第3步创建了包含字段access-token的数据表user，而且利用gii上生成了相应的model和controller

配置main.php文件

'components' => [
    'user' => [ 
        'identityClass' => 'common\models\User',
        'enableAutoLogin' => true,
        'enableSession'=>false
    ],
],

为控制器配置authenticator行为指定认证方式

<?php

namespace api\modules\v1\controllers;

use yii\rest\ActiveController;
use yii\helpers\ArrayHelper;
use yii\filters\auth\QueryParamAuth;

class UserController extends ActiveController
{
    public $modelClass = 'api\models\User';

    public function behaviors() {
        return ArrayHelper::merge (parent::behaviors(), [ 
                'authenticator' => [ 
                    'class' => QueryParamAuth::className() 
                ] 
        ] );
    }
}

最后我们还需要在identityClass中实现findIdentityByAccessToken方法

public static function findIdentityByAccessToken($token, $type = null)
{
    return static::findOne(['access_token' => $token, 'status' => self::STATUS_ACTIVE]);
}

如此一来，我们先通过postman模拟不带access-token请求看结果

{
  "name": "Unauthorized",
  "message": "You are requesting with an invalid credential.",
  "code": 0,
  "status": 401,
  "type": "yii\\web\\UnauthorizedHttpException"
}

提示401 我们没有权限访问！

我们在请求的链接上携带正确的access-token，认证通过后，控制器会再继续执行其他检查（频率限制、操作权限等），才可以返回正确的用户信息。

需要提醒的是：通过url的形式对access-token传递存在一定的风险，有可能会造成数据的泄漏！一般而言，access-token需要放到HTTP头中进行传递！除非客户端的请求是jsonp格式的！

关于授权认证，我们有一篇更详细的文章，包括一套完整案例、服务端返回的数据类型定义、自定义错误机制等。走，去看看？当然，本篇文章的后半部分也很精彩，还没走的，我们继续阅读。

8、速率限制

速率限制，该操作完全也是出于安全考虑，我们需要限制同一接口某时间段过多的请求。

速率限制默认不启用，用启用速率限制，yii\web\User::identityClass 应该实现yii\filters\RateLimitInterface，也就是说我们的common\models\User.php需要实现yii\filters\RateLimitInterface接口的三个方法，具体代码可参考：

use yii\filters\RateLimitInterface;
use yii\web\IdentityInterface;

class User extends ActiveRecord implements IdentityInterface, RateLimitInterface
{
    // other code ...... 

    // 返回某一时间允许请求的最大数量，比如设置10秒内最多5次请求（小数量方便我们模拟测试）
    public  function getRateLimit($request, $action){  
         return [5, 10];  
    }
     
    // 回剩余的允许的请求和相应的UNIX时间戳数 当最后一次速率限制检查时
    public  function loadAllowance($request, $action){  
         return [$this->allowance, $this->allowance_updated_at];  
    }  
     
    // 保存允许剩余的请求数和当前的UNIX时间戳
    public  function saveAllowance($request, $action, $allowance, $timestamp){ 
        $this->allowance = $allowance;  
        $this->allowance_updated_at = $timestamp;  
        $this->save();  
    }  
}

需要注意的是，你仍然需要在数据表User中新增加两个字段

allowance：剩余的允许的请求数量
allowance_updated_at：相应的UNIX时间戳数

在我们启用了速率限制后，Yii 会自动使用 yii\filters\RateLimiter 为 yii\rest\Controller 配置一个行为过滤器来执行速率限制检查。

现在我们通过postman请求v1/users再看看结果，会发现在10秒内调用超过5次API接口，我们会得到状态为429太多请求的异常信息。

{
  "name": "Too Many Requests",
  "message": "Rate limit exceeded.",
  "code": 0,
  "status": 429,
  "type": "yii\\web\\TooManyRequestsHttpException"
}

9、关于版本

为了兼容历史版本而且考虑向后兼容性，我们在一开始操作的时候就以URL的方式实现了版本话，这里就不再进行阐述了。

10、错误处理

Yii的REST框架的HTTP状态代码可参考如下就好，没啥好说的

200: OK。一切正常。
201: 响应 POST 请求时成功创建一个资源。Location header 包含的URL指向新创建的资源。
204: 该请求被成功处理，响应不包含正文内容 (类似 DELETE 请求)。
304: 资源没有被修改。可以使用缓存的版本。
400: 错误的请求。可能通过用户方面的多种原因引起的，例如在请求体内有无效的JSON 数据，无效的操作参数，等等。
401: 验证失败。
403: 已经经过身份验证的用户不允许访问指定的 API 末端。
404: 所请求的资源不存在。
405: 不被允许的方法。请检查 Allow header 允许的HTTP方法。
415: 不支持的媒体类型。所请求的内容类型或版本号是无效的。
422: 数据验证失败 (例如，响应一个 POST 请求)。请检查响应体内详细的错误消息。
429: 请求过多。由于限速请求被拒绝。
500: 内部服务器错误。这可能是由于内部程序错误引起的。

posted @ 2017-03-16 12:51 岁月静好13543 阅读(738) 评论(0) 编辑收藏举报

刷新页面返回顶部

岁月如歌

yii2 restful api——app接口编程实例