Yii2框架製作RESTful風格的API快速入門教學

先跟大家說下什麼是REST

restful

REST全稱是Representational State Transfer，中文意思是表述（編者註：通常譯為表徵）性狀態轉移。 它首次出現在2000年Roy Fielding的博士論文中，Roy Fielding是HTTP規範的主要編寫者之一。 他在論文中提到："我這篇文章的寫作目的，就是想在符合架構原理的前提下，理解和評估以網絡為基礎的應用軟體的架構設計，得到一個功能強、性能好、適宜通信的架構。

REST本身並沒有創造新的技術、元件或服務，而隱藏在RESTful背後的理念就是使用Web的現有特徵和能力， 更好地使用現有Web標準中的一些準則和限制。雖然REST本身受Web技術的影響很深，但理論上REST架構風格並不是綁定在HTTP上，只不過目前HTTP是唯一與REST相關的實例。 所以我們這裡描述的REST也是透過HTTP實現的REST。

前不久做一個項目，是用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 / {}"中加入下面紅色標記內容：

reee

2.修改frontend/config/main.php文件，為book控制器增加一個URL 規則。這樣，就能透過美化的 URL 和有意義的 http 動詞進行存取和操作資料。設定如下：

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

   

三、建立一個model

1.在資料庫中建立一張book表。 book表的內容如下：

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

   

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

-- ----------------------------
-- 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');

   

四、建立一個控制器

在frontend/controllers/目錄中新建BookController.php。控制器類別擴展自 yiirestActiveController。透過指定 yiirestActiveController::modelClass 作為 frontendmodelsBook， 控制器就能知道要使用哪個模型去取得和處理資料。文件內容如下：

namespace frontend\models;
use yii\db\ActiveRecord;
class Book extends ActiveRecord
{
public static function tableName()
{
return '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 將在末端使用的控制器的名稱自動變為複數。這是因為 yiirestUrlRule 能夠為他們使用的末端全自動複數化控制器。可以透過設定yiirestUrlRule::pluralize為false來停用此行為:

namespace frontend\controllers;
use yii\rest\ActiveController;
class BookController extends ActiveController
{
public $modelClass = 'frontend\models\Book';
}

   

2.可以使用fields和expand參數指定哪些欄位應該包含在結果內。例如：URL http://{frontend的網域}/books?fields=name,num 只會傳回 name 和 num 欄位。

以上所述是小編給大家介紹的Yii2框架製作RESTful風格的API快速入門教程，希望對大家有所幫助，如果大家有任何疑問請給我留言，小編會及時回復大家的。在此也非常感謝大家對PHP中文網的支持！

更多Yii2框架製作RESTful風格的API快速入門教學相關文章請關注PHP中文網！