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

一、創建單獨的應用程序

爲了增長程序的可維護性，易操做性，咱們選擇新建一套應用程序，這也是爲了和前臺應用、後臺應用區分開操做。有些人要嚷嚷了，爲啥非得單獨搞一套呢？若是你就單純的提供個別的幾個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'); 

二、爲新建的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 

三、利用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', ], ], ...... 

四、從新配置控制器

爲了實現restful風格的api,在yii2中，咱們須要對控制器進行一下改寫

<?php namespace api\modules\v1\controllers; use yii\rest\ActiveController; class GoodsController extends ActiveController { public $modelClass = 'api\models\Goods'; } 

五、爲Goods配置Url規則

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

六、模擬請求操做

通過上面幾個步驟，到此咱們已經爲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架構中，網址中只能有名詞而不能包含動詞，名詞又每每與數據表相對應，數據表呢又是一個「集合」，所以該名詞每每是複數的形式。

七、關於受權認證

爲何須要受權認證？這在通常的操做中是須要的。好比說用戶要設置本身的信息。

爲了對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格式的！

關於受權認證，咱們有一篇更詳細的文章，包括一套完整案例、服務端返回的數據類型定義、自定義錯誤機制等。走，去看看？固然，本篇文章的後半部分也很精彩，還沒走的，咱們繼續閱讀。

八、速率限制

速率限制，該操做徹底也是出於安全考慮，咱們須要限制同一接口某時間段過多的請求。

速率限制默認不啓用，用啓用速率限制，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中新增長兩個字段

1. allowance：剩餘的容許的請求數量
2. 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" } 

九、關於版本

爲了兼容歷史版本並且考慮向後兼容性，咱們在一開始操做的時候就以URL的方式實現了版本話，這裏就再也不進行闡述了。

十、錯誤處理

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: 內部服務器錯誤。 這多是因爲內部程序錯誤引發的。