什么是restful風格的api
對于各種客戶端設備與服務端的通信，我們往往都通過api為客戶端提供數據，提供某種資源。關于restful的概念，一查一大推，一兩句也解釋不清，姑且先按照我們通俗的理解：在眾多風格、眾多原則的api中，restful就是一套比較優秀的接口調用方式。
yii2如何實現restful風格的api
1、建立單獨的應用程序
為了增加程序的可維護性，易操作性，我們選擇新建一套應用程序，這也是為了和前臺應用、后臺應用區分開操作。有些人要嚷嚷了，為啥非得單獨搞一套呢？如果你就單純的提供個別的幾個h5頁面的話，那就沒有必要了，但事實往往是客戶端要升級啊，要增加不同的版本啊，這就需要我們不但要后端不僅要增加一套單獨的應用程序，我們還要增加各種版本去控制。
在web前端（frontend）和后端（backend）的同級目錄，新建一個文件夾，命名api,其目錄結構如下所示：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
|
├─assets│ appasset.php├─config│ bootstrap.php│ main-local.php│ main.php│ params-local.php│ params.php├─runtime└─web│ index.php├─assets└─css |
可以看出其目錄結構基本上同backend沒有其他差異，因為我們就是拷貝backend項目，只是做了部分優化。
2、為新建的api應用程序美化路由
首先保證你的web服務器開啟rewrite規則，細節我們就不說了，不過這是前提。
接著配置api/config/main.php文件
|
1
2
3
4
5
6
7
8
9
|
'components' => [// other config'urlmanager' => ['enableprettyurl' => true,'showscriptname' => false,'enablestrictparsing' =>true,'rules' => [],]], |
最后只需要在應用入口同級增加.htaccess文件就好，我們以apache為例
|
1
2
3
4
5
6
7
8
9
10
|
options +followsymlinksindexignore */*rewriteengine on# if a directory or a file exists, use it directlyrewritecond %{request_filename} !-frewritecond %{request_filename} !-d# otherwise forward it to index.phprewriterule . index.phprewriterule \.svn\/ /404.htmlrewriterule \.git\/ /404.html |
3、利用gii生成測試modules
用了便于演示說明，我們新建一張數據表goods表，并向其中插入幾條數據。
|
1
2
3
4
5
6
7
8
9
10
|
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目錄結構應該多個下面這幾個目錄
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
|
│├─models│ goods.php│├─modules│ └─v1│ │ module.php│ ││ ├─controllers│ │ defaultcontroller.php│ │ goodscontroller.php│ ││ └─views│ └─default│ index.php |
4、重新配置控制器
為了實現restful風格的api,在yii2中，我們需要對控制器進行一下改寫
|
1
2
3
4
5
6
7
|
<?phpnamespace api\modules\v1\controllers;use yii\rest\activecontroller;class goodscontroller extends activecontroller{public $modelclass = 'api\models\goods';} |
5、為goods配置url規則
|
1
2
3
4
5
6
|
'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文件
|
1
2
3
4
5
6
7
|
'components' => ['user' => [ 'identityclass' => 'common\models\user','enableautologin' => true,'enablesession'=>false],], |
為控制器配置authenticator行為指定認證方式
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
|
<?phpnamespace 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方法
|
1
2
3
4
|
public static function findidentitybyaccesstoken($token, $type = null){return static::findone(['access_token' => $token, 'status' => self::status_active]);} |
如此一來，我們先通過postman模擬不帶access-token請求看結果
|
1
2
3
4
5
6
7
|
{"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接口的三個方法，具體代碼可參考：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
|
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太多請求的異常信息。
|
1
2
3
4
5
6
7
|
{"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: 內部服務器錯誤。 這可能是由于內部程序錯誤引起的。
