程式師世界 >> 編程語言 >> 網頁編程 >> PHP編程 >> 關於PHP編程 >> yii2 RESTful api的詳細使用，yii2restful

yii2 RESTful api的詳細使用，yii2restful

編輯：關於PHP編程

yii2 RESTful api的詳細使用，yii2restful

什麼是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項目，只是做了部分優化。

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

4、重新配置控制器

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

<?php
@see http://www.manks.top/yii2_restful_api.html
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
@see http://www.manks.top/yii2_restful_api.html
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格式的！

[考慮目前國內網站大部分采集文章十分頻繁，更有甚者不注明原文出處，原作者更希望看客們查看原文，以防有任何問題不能更新所有文章，避免誤導！]

查看原文