Yii2框架如何制作RESTful風(fēng)格的API-創(chuàng)新互聯(lián)
這篇文章主要介紹了Yii2框架如何制作RESTful風(fēng)格的API，具有一定借鑒價(jià)值，感興趣的朋友可以參考下，希望大家閱讀完這篇文章之后大有收獲，下面讓小編帶著大家一起了解一下。
restful
REST全稱(chēng)是Representational State Transfer，中文意思是表述（編者注：通常譯為表征）性狀態(tài)轉(zhuǎn)移。 它首次出現(xiàn)在2000年Roy Fielding的博士論文中，Roy Fielding是HTTP規(guī)范的主要編寫(xiě)者之一。 他在論文中提到："我這篇文章的寫(xiě)作目的，就是想在符合架構(gòu)原理的前提下，理解和評(píng)估以網(wǎng)絡(luò)為基礎(chǔ)的應(yīng)用軟件的架構(gòu)設(shè)計(jì)，得到一個(gè)功能強(qiáng)、性能好、適宜通信的架構(gòu)。REST指的是一組架構(gòu)約束條件和原則。" 如果一個(gè)架構(gòu)符合REST的約束條件和原則，我們就稱(chēng)它為RESTful架構(gòu)。
REST本身并沒(méi)有創(chuàng)造新的技術(shù)、組件或服務(wù)，而隱藏在RESTful背后的理念就是使用Web的現(xiàn)有特征和能力， 更好地使用現(xiàn)有Web標(biāo)準(zhǔn)中的一些準(zhǔn)則和約束。雖然REST本身受Web技術(shù)的影響很深， 但是理論上REST架構(gòu)風(fēng)格并不是綁定在HTTP上，只不過(guò)目前HTTP是與REST相關(guān)的實(shí)例。 所以我們這里描述的REST也是通過(guò)HTTP實(shí)現(xiàn)的REST。
前不久做一個(gè)項(xiàng)目，是用Yii2框架寫(xiě)一套R(shí)ESTful風(fēng)格的API，就去查了下《Yii 2.0 權(quán)威指南 》，發(fā)現(xiàn)上面寫(xiě)得比較簡(jiǎn)略。所以就在這里寫(xiě)一篇教程貼，希望幫助剛接觸Yii2框架RESTful的小伙伴快速入門(mén)。
一、目錄結(jié)構(gòu)
實(shí)現(xiàn)一個(gè)簡(jiǎn)單地RESTful API只需用到三個(gè)文件。目錄如下：
frontend ├─ config │ └ main.php ├─ controllers │ └ BookController.php └─ models └ Book.php
二、配置URL規(guī)則
1.修改服務(wù)器的rewrite規(guī)則，將所有URL全部指向index.php上，使其支持 /books/1 格式。
如果是Apache服務(wù)器，在frontend/web/ 目錄中新建.htaccess文件。文件內(nèi)容如下：
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服務(wù)器，修改nginx/conf/nginx.conf，在當(dāng)前"server{}"的"location / {}"中添加下面紅色標(biāo)記內(nèi)容：
location / {
try_files $uri $uri/ /index.php$is_args$args;
}2.修改frontend/config/main.php文件，為book控制器增加一個(gè) URL 規(guī)則。這樣，就能通過(guò)美化的 URL 和有意義的 http 動(dòng)詞進(jìn)行訪(fǎng)問(wèn)和操作數(shù)據(jù)。配置如下：
'components' => [ 'urlManager' => [ 'enablePrettyUrl' => true, 'enableStrictParsing' => true, 'showScriptName' => false, 'rules' => [ ['class' => 'yii\rest\UrlRule', 'controller' => 'book'], ], ], ],
三、創(chuàng)建一個(gè)model
1.在數(shù)據(jù)庫(kù)中創(chuàng)建一張book表。book表的內(nèi)容如下：
-- ----------------------------
-- 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。文件內(nèi)容如下：
namespace frontend\models;
use yii\db\ActiveRecord;
class Book extends ActiveRecord
{
public static function tableName()
{
return 'book';
}
}四、創(chuàng)建一個(gè)控制器
在frontend/controllers/目錄中新建BookController.php?？刂破黝?lèi)擴(kuò)展自 yii\rest\ActiveController。通過(guò)指定 yii\rest\ActiveController::modelClass 作為 frontend\models\Book， 控制器就能知道使用哪個(gè)模型去獲取和處理數(shù)據(jù)。文件內(nèi)容如下：
namespace frontend\controllers;
use yii\rest\ActiveController;
class BookController extends ActiveController
{
public $modelClass = 'frontend\models\Book';
}五、測(cè)試
到這里，我們就已經(jīng)完成了創(chuàng)建用于訪(fǎng)問(wèn)用戶(hù)數(shù)據(jù) 的 RESTful 風(fēng)格的 API。創(chuàng)建的 API 包括：
GET /books: 列出所有的書(shū)
HEAD /books: 顯示書(shū)的列表的概要信息
POST /books: 新增1本書(shū)
GET /books/1: 返回 書(shū)ID=1的詳細(xì)信息
HEAD /books/1: 顯示 書(shū)ID=1的概述信息
PATCH /books/1 and PUT /books/1: 更新書(shū)ID=1的信息
DELETE /books/1: 刪除書(shū)ID=1的信息
OPTIONS /books: 顯示關(guān)于末端 /books 支持的動(dòng)詞
OPTIONS /books/1: 顯示有關(guān)末端 /books/1 支持的動(dòng)詞
可以通過(guò)Web瀏覽器中輸入 URL http://{frontend的域名}/books 來(lái)訪(fǎng)問(wèn)API，或者使用一些瀏覽器插件來(lái)發(fā)送特定的 headers 請(qǐng)求，比如Firefox的RestClient、Chrome的Advanced Rest Client、postman等。
六、說(shuō)明
1.Yii 將在末端使用的控制器的名稱(chēng)自動(dòng)變?yōu)閺?fù)數(shù)。這是因?yàn)?yii\rest\UrlRule 能夠?yàn)樗麄兪褂玫哪┒巳詣?dòng)復(fù)數(shù)化控制器?？梢酝ㄟ^(guò)設(shè)置yii\rest\UrlRule::pluralize為false來(lái)禁用此行為:
'rules' => [ ['class' => 'yii\rest\UrlRule', 'controller' => 'book', 'pluralize' => false], ],
2.可以使用fields和expand參數(shù)指定哪些字段應(yīng)該包含在結(jié)果內(nèi)。例如：URL http://{frontend的域名}/books?fields=name,num 將只返回 name 和 num 字段。
感謝你能夠認(rèn)真閱讀完這篇文章，希望小編分享的“Yii2框架如何制作RESTful風(fēng)格的API”這篇文章對(duì)大家有幫助，同時(shí)也希望大家多多支持創(chuàng)新互聯(lián)網(wǎng)站建設(shè)公司，，關(guān)注創(chuàng)新互聯(lián)行業(yè)資訊頻道，更多相關(guān)知識(shí)等著你來(lái)學(xué)習(xí)!
本文標(biāo)題：Yii2框架如何制作RESTful風(fēng)格的API-創(chuàng)新互聯(lián)
轉(zhuǎn)載源于：http://m.jiaotiyi.com/article/hgphs.html