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

一、目錄結構

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

frontend
    ├─ config
    │   └ main.php
    ├─ controllers
    │   └ BookController.php
    └─ models
        └ Book.php

二、配置URL規則

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

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 / {}"中添加下面紅色標記內容：

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‘],
        ],
    ],
],

三、創建一個model

1.在數據庫中創建一張book表。book表的內容如下：

-- ----------------------------
-- 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‘;
    }
}

四、創建一個控制器

在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‘;
}

五、測試

到這裏，我們就已經完成了創建用於訪問用戶數據 的 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等。

六、說明

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 API教程（二） - 格式化響應，授權認證和速率限制

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