2. 程式人生 > >Yii2框架RESTful API教程（二） - 格式化響應，授權認證和速率限制

Yii2框架RESTful API教程（二） - 格式化響應，授權認證和速率限制

阿新 • • 發佈：2017-07-13
formatter loginurl 而不是 filters ica cat 表示 程序 ssi

之前寫過一篇Yii2框架RESTful API教程（一） - 快速入門，今天接著來探究一下Yii2 RESTful的格式化響應，授權認證和速率限制三個部分

一、目錄結構

先列出需要改動的文件。目錄如下：

web
 ├─ common
 │      └─ models 
 │              └ User.php
 └─ frontend
        ├─ config
        │   └ main.php
        └─ controllers
            └ BookController.php

二、格式化響應

Yii2 RESTful支持JSON和XML格式，如果想指定返回數據的格式，需要配置yii\filters\ContentNegotiator::formats屬性。例如，要返回JSON格式，修改frontend/controllers/BookController.php，加入紅色標記代碼:

namespace frontend\controllers;

use yii\rest\ActiveController;
use yii\web\Response;

class BookController extends ActiveController
{
    public $modelClass = ‘frontend\models\Book‘;

    public function behaviors() {
        $behaviors = parent::behaviors();
        $behaviors[‘contentNegotiator‘][‘formats‘][‘text/html‘] = Response::FORMAT_JSON;
        return $behaviors;
    }
}

返回XML格式：FORMAT_XML。formats屬性的keys支持MIME類型，而values必須在yii\web\Response::formatters中支持被響應格式名稱。

三、授權認證

RESTful APIs通常是無狀態的，因此每個請求應附帶某種授權憑證，即每個請求都發送一個access token來認證用戶。

1.配置user應用組件（不是必要的，但是推薦配置）：
　　設置yii\web\User::enableSession屬性為false（因為RESTful APIs為無狀態的，當yii\web\User::enableSession為false，請求中的用戶認證狀態就不能通過session來保持）

　　設置yii\web\User::loginUrl屬性為null（顯示一個HTTP 403 錯誤而不是跳轉到登錄界面）
具體方法，修改frontend/config/main.php，加入紅色標記代碼：

‘components‘ => [
    ...
    ‘user‘ => [
        ‘identityClass‘ => ‘common\models\User‘,
        ‘enableAutoLogin‘ => true,
        
        ‘enableSession‘ => false,
        ‘loginUrl‘ => null,
        
    ],
    ...
]

2.在控制器類中配置authenticator行為來指定使用哪種認證方式，修改frontend/controllers/BookController.php，加入紅色標記代碼：

namespace frontend\controllers;

use yii\rest\ActiveController;
use yii\web\Response;

use yii\filters\auth\CompositeAuth;
use yii\filters\auth\QueryParamAuth;

class BookController extends ActiveController
{
    public $modelClass = ‘frontend\models\Book‘;

    public function behaviors() {
        $behaviors = parent::behaviors();
    
        $behaviors[‘authenticator‘] = [
            ‘class‘ => CompositeAuth::className(),
            ‘authMethods‘ => [
                /*下面是三種驗證access_token方式*/
                //1.HTTP 基本認證: access token 當作用戶名發送，應用在access token可安全存在API使用端的場景，例如，API使用端是運行在一臺服務器上的程序。
                //HttpBasicAuth::className(),
                //2.OAuth 2: 使用者從認證服務器上獲取基於OAuth2協議的access token，然後通過 HTTP Bearer Tokens 發送到API 服務器。
                //HttpBearerAuth::className(),
                //3.請求參數: access token 當作API URL請求參數發送，這種方式應主要用於JSONP請求，因為它不能使用HTTP頭來發送access token
                //http://localhost/user/index/index?access-token=123
                QueryParamAuth::className(),
            ],
        ];
        
        $behaviors[‘contentNegotiator‘][‘formats‘][‘text/html‘] = Response::FORMAT_JSON;
        return $behaviors;
    }
}

3.創建一張user表

-- ----------------------------
-- Table structure for user
-- ----------------------------
DROP TABLE IF EXISTS `user`;
CREATE TABLE `user` (
  `id` int(10) unsigned NOT NULL AUTO_INCREMENT,
  `username` varchar(20) NOT NULL DEFAULT ‘‘ COMMENT ‘用戶名‘,
  `password_hash` varchar(100) NOT NULL DEFAULT ‘‘ COMMENT ‘密碼‘,
  `password_reset_token` varchar(50) NOT NULL DEFAULT ‘‘ COMMENT ‘密碼token‘,
  `email` varchar(20) NOT NULL DEFAULT ‘‘ COMMENT ‘郵箱‘,
  `auth_key` varchar(50) NOT NULL DEFAULT ‘‘,
  `status` tinyint(3) unsigned NOT NULL DEFAULT ‘0‘ COMMENT ‘狀態‘,
  `created_at` int(10) unsigned NOT NULL DEFAULT ‘0‘ COMMENT ‘創建時間‘,
  `updated_at` int(10) unsigned NOT NULL DEFAULT ‘0‘ COMMENT ‘更新時間‘,
  `access_token` varchar(50) NOT NULL DEFAULT ‘‘ COMMENT ‘restful請求token‘,
  `allowance` int(10) unsigned NOT NULL DEFAULT ‘0‘ COMMENT ‘restful剩余的允許的請求數‘,
  `allowance_updated_at` int(10) unsigned NOT NULL DEFAULT ‘0‘ COMMENT ‘restful請求的UNIX時間戳數‘,
  PRIMARY KEY (`id`),
  UNIQUE KEY `username` (`username`),
  UNIQUE KEY `access_token` (`access_token`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

-- ----------------------------
-- Records of user
-- ----------------------------
INSERT INTO `user` VALUES (‘1‘, ‘admin‘, ‘$2y$13$1KWwchqGvxDeORDt5pRW.OJarf06PjNYxe2vEGVs7e5amD3wnEX.i‘, ‘‘, ‘‘, ‘z3sM2KZvXdk6mNXXrz25D3JoZlGXoJMC‘, ‘10‘, ‘1478686493‘, ‘1478686493‘, ‘123‘, ‘4‘, ‘1478686493‘);

在common/models/User.php類中實現 yii\web\IdentityInterface::findIdentityByAccessToken()方法。修改common/models/User.php，加入紅色標記代碼：：

public static function findIdentityByAccessToken($token, $type = null)
{
    //findIdentityByAccessToken()方法的實現是系統定義的
    //例如，一個簡單的場景，當每個用戶只有一個access token, 可存儲access token 到user表的access_token列中， 方法可在User類中簡單實現，如下所示：
    return static::findOne([‘access_token‘ => $token]);
    //throw new NotSupportedException(‘"findIdentityByAccessToken" is not implemented.‘);
}

四、速率限制

為防止濫用，可以增加速率限制。例如，限制每個用戶的API的使用是在60秒內最多10次的API調用，如果一個用戶同一個時間段內太多的請求被接收，將返回響應狀態代碼 429 (這意味著過多的請求)。

1.Yii會自動使用yii\filters\RateLimiter為yii\rest\Controller配置一個行為過濾器來執行速率限制檢查。如果速度超出限制，該速率限制器將拋出一個yii\web\TooManyRequestsHttpException。
修改frontend/controllers/BookController.php，加入紅色標記代碼：

namespace frontend\controllers;

use yii\rest\ActiveController;
use yii\web\Response;
use yii\filters\auth\CompositeAuth;
use yii\filters\auth\QueryParamAuth;

use yii\filters\RateLimiter;

class BookController extends ActiveController
{
    public $modelClass = ‘frontend\models\Book‘;

    public function behaviors() {
        $behaviors = parent::behaviors();
        
        $behaviors[‘rateLimiter‘] = [
            ‘class‘ => RateLimiter::className(),
            ‘enableRateLimitHeaders‘ => true,
        ];
        
        $behaviors[‘authenticator‘] = [
            ‘class‘ => CompositeAuth::className(),
            ‘authMethods‘ => [
                /*下面是三種驗證access_token方式*/
                //1.HTTP 基本認證: access token 當作用戶名發送，應用在access token可安全存在API使用端的場景，例如，API使用端是運行在一臺服務器上的程序。
                //HttpBasicAuth::className(),
                //2.OAuth 2: 使用者從認證服務器上獲取基於OAuth2協議的access token，然後通過 HTTP Bearer Tokens 發送到API 服務器。
                //HttpBearerAuth::className(),
                //3.請求參數: access token 當作API URL請求參數發送，這種方式應主要用於JSONP請求，因為它不能使用HTTP頭來發送access token
                //http://localhost/user/index/index?access-token=123
                QueryParamAuth::className(),
            ],
        ];
        $behaviors[‘contentNegotiator‘][‘formats‘][‘text/html‘] = Response::FORMAT_JSON;
        return $behaviors;
    }
}

2.在user表中使用兩列來記錄容差和時間戳信息。為了提高性能，可以考慮使用緩存或NoSQL存儲這些信息。
修改common/models/User.php，加入紅色標記代碼：

namespace common\models;

use Yii;
use yii\base\NotSupportedException;
use yii\behaviors\TimestampBehavior;
use yii\db\ActiveRecord;
use yii\web\IdentityInterface;

use yii\filters\RateLimitInterface;

class User extends ActiveRecord implements IdentityInterface, RateLimitInterface
{

    ....

    // 返回在單位時間內允許的請求的最大數目，例如，[10, 60] 表示在60秒內最多請求10次。
    public function getRateLimit($request, $action)
    {
        return [5, 10];
    }

    // 返回剩余的允許的請求數。
    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();
    }
    
    ....
    
    public static function findIdentityByAccessToken($token, $type = null)
    {
        //throw new NotSupportedException(‘"findIdentityByAccessToken" is not implemented.‘);
        //findIdentityByAccessToken()方法的實現是系統定義的
        //例如，一個簡單的場景，當每個用戶只有一個access token, 可存儲access token 到user表的access_token列中， 方法可在User類中簡單實現，如下所示：
        return static::findOne([‘access_token‘ => $token]);
    }
    
    ....
}

PHP的RESTful實例： PHP實現RESTful風格的API實例

Yii2框架RESTful API教程（二） - 格式化響應，授權認證和速率限制

相關推薦

Yii2框架RESTful API教程（二） - 格式化響應，授權認證和速率限制

formatter loginurl 而不是 filters ica cat 表示 程序 ssi 之前寫過一篇Yii2框架RESTful API教程（一） - 快速入門，今天接著來探究一下Yii2 RESTful的格式化響應，授權認證和速率限制三個部分 一、目錄結構 先

Yii2框架RESTful API教程（一） - 快速入門

比較 exp values cnblogs -- restful extends .cn pat 前不久做一個項目，是用Yii2框架寫一套RESTful風格的API，就去查了下《Yii 2.0 權威指南 》，發現上面寫得比較簡略。所以就在這裏寫一篇教程貼，希望幫助剛接觸Yi

ThinkJS框架入門詳細教程（二）新手入門項目

logs connect 項目 目錄 itl 合並 sql文件 生產 js框架 一、準備工作 參考前一篇：ThinkJS框架入門詳細教程（一）開發環境 安裝thinkJS命令 npm install -g think-cli 監測是否安裝成功 thin

SpringBoot 學習-restful api 開發（二）

SpringBoot 開發resful api 比之前mvc restful api 更為快捷和簡單。正所謂 沒有對比就沒有傷害，在介紹SpringBoot的寫法之前，我們先看看SpringMVC 是如果實現 restful api的。在這裡我將寫一個使用者的增刪該查 res

API 系列教程（二）：結合 Laravel 5.5 和 Vue SPA 基於 jwt-auth 實現 API 認證

上一篇我們簡單演示了 Laravel 5.5 中 RESTful API 的構建、認證和測試，本教程將在上一篇教程的基礎上進行昇華。 我們將結合 Laravel 和 Vue 單頁面應用（SPA），在它們的基礎上引入 jwt-auth 實現 API 認證，由於 Laravel 集成了對 Vue

YII2框架學習 基礎篇（二） YII2資料庫操作

實際專案中PHP肯定離不開資料庫，YII框架有很多針對資料庫的操作，學習一下。學習YII框架資料庫指令的同時，也可以學到YII框架的資料模型，一石二鳥啊。另外，昨天釋出了第一篇後，發現有幾十個人看了我的http://blog.csdn.net/m0_37645820/art

OpenStack之RESTful API呼叫（二）

接著上面的文章，我們繼續來談RESTful API。我們知道RESTful API訪問的URL都稱之為“資源”。一個資源可能是一個集合，也可能是一個個體。要實現複雜的功能，不可能只通過一條URL來完成，因此必須定義多條URL，如何定義多條URL也是RESTful API要考

scikit-learn機器學習（二）--嶺迴歸，Lasso迴歸和ElasticNet迴歸

多元線性迴歸模型中，為了是均方差誤差最小化，常見的做法是引入正則化，正則化就是給對模型的引數或者說是係數新增一些先驗假設，控制模型的空間，使模型的複雜度較小。 正則化目的：防止過擬合 正則化本質：約束要優化的引數 正則化會保留樣本的所有特徵向量，但是會

從零開始寫自己的PHP框架系列教程（二）[App.php]

porting col config exce tro efault fig 默認 clas 從這一個文件開始以後加載的均以類加載，請註意命名空間和所在文件的路徑 APP.php的這個類所在路徑:根目錄\framework\App.php 直接上代碼 namespace

Elastic Job 入門教程（二）— Spring Boot框架下是實現Elastic Job 指令碼作業（Script Job）

在Elastic Job 入門教程（一）— 與Spring Boot整合這篇文章中，我們簡單介紹了Spring Boot與Elastic Job 的整合，並簡單實現了SimpleJob型別作業。本章，我

Java NIO框架Netty教程（二）

“Hello World”的程式碼固然簡單，不過其中的幾個重要概念（類）和 Netty的工作原理還是需要簡單明確一下，至少知道其是負責什。方便自己以後更靈活的使用和擴充套件。 宣告，筆者一介碼農，不會那麼多專業的詞彙和縮寫，只能以最簡單蒼白的

Java NIO框架Netty教程（二） – 白話概念

剛說Pipeline負責把事件分發到相應的站點，那個這個站點在Netty裡，就是指ChannelHandler。事件到了ChannelHandler這裡，就要被具體的進行處理了，我們的樣例程式碼裡，實現的就是這樣一個處理事件的“站點”，也就是說，你自己的業務邏輯一般都是從這裡開始的。 Channel 有了

搭建 rbac 後臺系列教程（二）—— 安裝 AdminLTE 渲染後臺和 yii2-admin 整合 rbac

一、安裝 AdminLTE 渲染後臺 1、利用 AdminLTE 渲染後臺模板 AdminLTE 是一個完全響應管理模板。基於 Bootstrap3 框架，易定製模板。適合多種螢幕解析度，從小型移動裝置到大型桌上型電腦。內建了多個頁面，包括儀表盤、郵箱、日曆、鎖屏、登入及註冊、404錯誤、500錯誤等頁面。

iptables實用教程（二）：管理鏈和策略

否則 命令顯示 accept 目的 number cep 存在 當前 末尾 概念和原理請參考上一篇文章“iptables實用教程（一）”。 本文講解如果管理iptables中的鏈和策略。 下面的代碼格式中，下劃線表示是一個占位符，需要根據實際情況輸入參數，不帶下劃線的表示是

Qt 3D教程（二）初步顯示3D的內容

初始 應用 frame 通過 net settings mod rgba bsp Qt3D教程（二）初步顯示3D的內容 前一篇很easy，全然就沒有牽涉到3D的內容，它僅僅是我們搭建3D應用的基本框架而已，而這一篇。我們將要利用它來初步地顯示3D

Python入門系列教程（二）

字符 小寫 無符號 bsp div width raw_input abc body 字符串 1.字符串輸出 name = ‘xiaoming‘ print("姓名：%s"%name) 2.字符串輸入 userName = raw_input(‘請輸

Nginx實用教程（二）：配置文件入門

affinity type 服務 源碼編譯 設置時間 shutdown ber 可用 控制指令 Nginx配置文件結構 nginx配置文件由指令（directive）組成，指令分為兩種形式，簡單指令和區塊指令。 一條簡單指令由指令名、參數和結尾的分號（;）組成，例如：

linux設備驅動之misc驅動框架源碼分析（二）

linux驅動開發misc設備驅動1、misc_open函數分析 該函數在driver/char/misc.c中，misc.c是驅動框架實現的，這裏面的misc_Open函數是misc驅動框架為應用層提供的一個打開misc設備的一個接口。 1、首先我們要知道在misc.c中的misc_init函數

CodeArt入門教程（二）

本質 文件夾 不同的 存在 切換數據庫 站點 ear 新的 組裝 4.第一個示例的編碼工作 　　使用CA編碼項目的核心結構是：由多個子系統組成多個不同的服務來提供項目的各種功能。請不要將這裏提到的子系統與大家在別的項目實施方法裏的概念混為一談，CA裏的子系統概念是完全不一樣

RobotFramework自動化測試框架的基礎關鍵字（二）

速查 語言 left 自動化 logs python語言 添加 src bsp 1.1.1 如何快速查詢某一個關鍵字的API說明 鼠標選中我們關鍵字，同時按住Ctrl+Alt鍵，即可出來該關鍵字的幫助API以及使用示例 1.1.2 如何快速補全