Yii2框架RESTful API教程

時間  2019-11-12
標籤 yii2 yii 框架 restful api 教程 欄目 PHP 简体版
原文   原文鏈接

前不久作一個項目，是用Yii2框架寫一套RESTful風格的API，就去查了下《Yii 2.0 權威指南 》，發現上面寫得比較簡略。因此就在這裏寫一篇教程貼，但願幫助剛接觸Yii2框架RESTful的小夥伴快速入門。php

1、目錄結構

實現一個簡單地RESTful API只需用到三個文件。目錄以下：html

複製代碼 
frontend
    ├─ config
    │   └ main.php
    ├─ controllers
    │   └ BookController.php
    └─ models
        └ Book.php
複製代碼

2、配置URL規則

1.修改服務器的rewrite規則，將全部URL所有指向index.php上，使其支持 /books/1 格式。
若是是Apache服務器，在frontend/web/ 目錄中新建.htaccess文件。文件內容以下：nginx

複製代碼 
RewriteEngine on
# If a directory or a file exists, use the request directly
    RewriteCond %{REQUEST_FILENAME} !-f
    RewriteCond %{REQUEST_FILENAME} !-d
# Otherwise forward the request to index.php
    RewriteRule . index.php
複製代碼

若是是Nginx服務器，修改nginx/conf/nginx.conf，在當前"server{}"的"location / {}"中添加下面紅色標記內容：web

location / {
　　try_files $uri $uri/ /index.php$is_args$args;
}

2.修改frontend/config/main.php文件，爲book控制器增長一個 URL 規則。這樣，就能經過美化的 URL 和有意義的 http 動詞進行訪問和操做數據。配置以下：數據庫

複製代碼 
'components' => [
    'urlManager' => [
        'enablePrettyUrl' => true,
        'enableStrictParsing' => true,
        'showScriptName' => false,
        'rules' => [
            ['class' => 'yii\rest\UrlRule', 'controller' => 'book'],
        ],
    ],
],
複製代碼

3、建立一個model

1.在數據庫中建立一張book表。book表的內容以下：json

複製代碼 
-- ----------------------------
-- Table structure for book
-- ----------------------------
DROP TABLE IF EXISTS `book`;
CREATE TABLE `book` (
  `id` int(10) unsigned NOT NULL AUTO_INCREMENT,
  `name` char(50) NOT NULL DEFAULT '',
  `num` tinyint(3) unsigned NOT NULL DEFAULT '0',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=6 DEFAULT CHARSET=utf8;

-- ----------------------------
-- Records of book
-- ----------------------------
INSERT INTO `book` VALUES ('1', 'toefl', '10');
INSERT INTO `book` VALUES ('2', 'ielts', '20');
INSERT INTO `book` VALUES ('3', 'sat', '30');
INSERT INTO `book` VALUES ('4', 'gre', '40');
INSERT INTO `book` VALUES ('5', 'gmat', '50');
複製代碼

2.在frontend/models/目錄中新建Book.php。文件內容以下：數組

複製代碼 
namespace frontend\models;

use yii\db\ActiveRecord;

class Book extends ActiveRecord
{
    public static function tableName()
    {
        return 'book';
    }
}
複製代碼

4、建立一個控制器

在frontend/controllers/目錄中新建BookController.php。控制器類擴展自 yii\rest\ActiveController。經過指定 yii\rest\ActiveController::modelClass 做爲 frontend\models\Book， 控制器就能知道使用哪一個模型去獲取和處理數據。文件內容以下：

瀏覽器

複製代碼 
namespace frontend\controllers;

use yii\rest\ActiveController;

class BookController extends ActiveController
{
    public $modelClass = 'frontend\models\Book';
}
複製代碼

5、測試

到這裏，咱們就已經完成了建立用於訪問用戶數據 的 RESTful 風格的 API。建立的 API 包括：緩存

複製代碼 
GET /books: 列出全部的書
HEAD /books: 顯示書的列表的概要信息
POST /books: 新增1本書
GET /books/1: 返回 書ID=1的詳細信息
HEAD /books/1: 顯示 書ID=1的概述信息
PATCH /books/1 and PUT /books/1: 更新書ID=1的信息
DELETE /books/1: 刪除書ID=1的信息
OPTIONS /books: 顯示關於末端 /books 支持的動詞
OPTIONS /books/1: 顯示有關末端 /books/1 支持的動詞
複製代碼

能夠經過Web瀏覽器中輸入 URL http://{frontend的域名}/books 來訪問API，或者使用一些瀏覽器插件來發送特定的 headers 請求，好比Firefox的RestClient、Chrome的Advanced Rest Client、postman等。安全

6、說明

1.Yii 將在末端使用的控制器的名稱自動變爲複數。這是由於 yii\rest\UrlRule 可以爲他們使用的末端全自動複數化控制器。能夠經過設置yii\rest\UrlRule::pluralize爲false來禁用此行爲:

'rules' => [
    ['class' => 'yii\rest\UrlRule', 'controller' => 'book', 'pluralize' => false],
],

2.可使用fields和expand參數指定哪些字段應該包含在結果內。例如：URL http://{frontend的域名}/books?fields=name,num 將只返回 name 和 num 字段。

今天接着來探究一下Yii2 RESTful的格式化響應，受權認證和速率限制三個部分

1、目錄結構

先列出須要改動的文件。目錄以下：

複製代碼 
web
 ├─ common
 │      └─ models 
 │              └ User.php
 └─ frontend
        ├─ config
        │   └ main.php
        └─ controllers
            └ BookController.php
複製代碼

2、格式化響應

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中支持被響應格式名稱。

3、受權認證

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.');
}
複製代碼

4、速率限制

爲防止濫用，能夠增長速率限制。例如，限制每一個用戶的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]);
    }
    
    ....
}
複製代碼
 

最近看了一些關於RESTful的資料，本身動手也寫了一個RESTful實例，如下是源碼

目錄詳情：

restful/
    Request.php 數據操做類
    Response.php 輸出類
    index.php 入口文件
    .htaccess 重寫url

Request.php ：包含一個Request類，即數據操做類。接收到URL的數據後，根據請求URL的方式（GET|POST|PUT|PATCH|DELETE）對數據進行相應的增刪改查操做，並返回操做後的結果：

複製代碼 
<?php

/**
 * 數據操做類
 */
class Request
{
    //容許的請求方式
    private static $method_type = array('get', 'post', 'put', 'patch', 'delete');
    //測試數據
    private static $test_class = array(
        1 => array('name' => '託福班', 'count' => 18),
        2 => array('name' => '雅思班', 'count' => 20),
    );

    public static function getRequest()
    {
        //請求方式
        $method = strtolower($_SERVER['REQUEST_METHOD']);
        if (in_array($method, self::$method_type)) {
            //調用請求方式對應的方法
            $data_name = $method . 'Data';
            return self::$data_name($_REQUEST);
        }
        return false;
    }

    //GET 獲取信息
    private static function getData($request_data)
    {
        $class_id = (int)$request_data['class'];
        //GET /class/ID：獲取某個指定班的信息
        if ($class_id > 0) {
            return self::$test_class[$class_id];
        } else {//GET /class：列出全部班級
            return self::$test_class;
        }
    }

    //POST /class：新建一個班
    private static function postData($request_data)
    {
        if (!empty($request_data['name'])) {
            $data['name'] = $request_data['name'];
            $data['count'] = (int)$request_data['count'];
            self::$test_class[] = $data;
            return self::$test_class;//返回新生成的資源對象
        } else {
            return false;
        }
    }

    //PUT /class/ID：更新某個指定班的信息（所有信息）
    private static function putData($request_data)
    {
        $class_id = (int)$request_data['class'];
        if ($class_id == 0) {
            return false;
        }
        $data = array();
        if (!empty($request_data['name']) && isset($request_data['count'])) {
            $data['name'] = $request_data['name'];
            $data['count'] = (int)$request_data['count'];
            self::$test_class[$class_id] = $data;
            return self::$test_class;
        } else {
            return false;
        }
    }

    //PATCH /class/ID：更新某個指定班的信息（部分信息）
    private static function patchData($request_data)
    {
        $class_id = (int)$request_data['class'];
        if ($class_id == 0) {
            return false;
        }
        if (!empty($request_data['name'])) {
            self::$test_class[$class_id]['name'] = $request_data['name'];
        }
        if (isset($request_data['count'])) {
            self::$test_class[$class_id]['count'] = (int)$request_data['count'];
        }
        return self::$test_class;
    }

    //DELETE /class/ID：刪除某個班
    private static function deleteData($request_data)
    {
        $class_id = (int)$request_data['class'];
        if ($class_id == 0) {
            return false;
        }
        unset(self::$test_class[$class_id]);
        return self::$test_class;
    }
}
複製代碼

Response.php ：包含一個Request類，即輸出類。根據接收到的Content-Type，將Request類返回的數組拼接成對應的格式，加上header後輸出

複製代碼 
<?php
/**
 * 輸出類
 */
class Response
{
    const HTTP_VERSION = "HTTP/1.1";

    //返回結果
    public static function sendResponse($data)
    {
        //獲取數據
        if ($data) {
            $code = 200;
            $message = 'OK';
        } else {
            $code = 404;
            $data = array('error' => 'Not Found');
            $message = 'Not Found';
        }

        //輸出結果
        header(self::HTTP_VERSION . " " . $code . " " . $message);
        $content_type = isset($_SERVER['CONTENT_TYPE']) ? $_SERVER['CONTENT_TYPE'] : $_SERVER['HTTP_ACCEPT'];
        if (strpos($content_type, 'application/json') !== false) {
            header("Content-Type: application/json");
            echo self::encodeJson($data);
        } else if (strpos($content_type, 'application/xml') !== false) {
            header("Content-Type: application/xml");
            echo self::encodeXml($data);
        } else {
            header("Content-Type: text/html");
            echo self::encodeHtml($data);
        }
    }

    //json格式
    private static function encodeJson($responseData)
    {
        return json_encode($responseData);
    }

    //xml格式
    private static function encodeXml($responseData)
    {
        $xml = new SimpleXMLElement('<?xml version="1.0"?><rest></rest>');
        foreach ($responseData as $key => $value) {
            if (is_array($value)) {
                foreach ($value as $k => $v) {
                    $xml->addChild($k, $v);
                }
            } else {
                $xml->addChild($key, $value);
            }
        }
        return $xml->asXML();
    }

    //html格式
    private static function encodeHtml($responseData)
    {
        $html = "<table border='1'>";
        foreach ($responseData as $key => $value) {
            $html .= "<tr>";
            if (is_array($value)) {
                foreach ($value as $k => $v) {
                    $html .= "<td>" . $k . "</td><td>" . $v . "</td>";
                }
            } else {
                $html .= "<td>" . $key . "</td><td>" . $value . "</td>";
            }
            $html .= "</tr>";
        }
        $html .= "</table>";
        return $html;
    }
}
複製代碼

index.php ：入口文件，調用Request類取得數據後交給Response處理，最後返回結果

複製代碼 
<?php
//數據操做類
require('Request.php');
//輸出類
require('Response.php');
//獲取數據
$data = Request::getRequest();
//輸出結果
Response::sendResponse($data);
複製代碼

下一篇：PHP實現RESTful風格的API實例（三）

http://www.cnblogs.com/luyucheng/p/6039856.html

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程