Yii2架構製作RESTful風格的API快速入門教程

先給大家說下什麼是REST

restful

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

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 directlyRewriteCond %{REQUEST_FILENAME} !-fRewriteCond %{REQUEST_FILENAME} !-d# Otherwise forward the request to index.phpRewriteRule . 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快速入門教程，希望對大家有所協助，如果大家有任何疑問請給我留言，小編會及時回複大家的。在此也非常感謝大家對topic.alibabacloud.com的支援！