Yii2.0 RESTful API 基礎(chǔ)配置教程詳解
最近在做Yii2.0 RESTful API功能，找了好久的資料，才找到這類的教程，感謝該作者，以下內(nèi)容根據(jù)我的項(xiàng)目實(shí)際情況做了一定的修改。
安裝yii2.0
安裝 Composer 后，您可以通過在 Web 可訪問的文件夾下運(yùn)行以下命令來 安裝Yii應(yīng)用程序模板：
composer create-project --prefer-dist yiisoft/yii2-app-basic basic
初始化高級模板
cd advanced ./init
輸入"./init"后會出現(xiàn)以下內(nèi)容
Yii Application Initialization Tool v1.0
Which environment do you want the application to be initialized in?
[0] Development
[1] ProductionYour choice [0-1, or "q" to quit] 0
Initialize the application under 'Development' environment? [yes|no] yes
Start initialization ...
修改數(shù)據(jù)庫連接屬性
打開 commonconfigmain-local.php,配置數(shù)據(jù)庫連接信息
'db' => [
'class' => 'yii\db\Connection',
'dsn' => 'mysql:host=127.0.0.1;dbname=yii',
'username' => 'root',
'password' => 'root',
'charset' => 'utf8',
],
執(zhí)行 migrate 數(shù)據(jù)庫遷移
./yii migrate
拷貝backend目錄，命名為api
打開apiconfigmain.php 修改id,controllerNamespace等，將所有backend替換為api：
return [ 'id' => 'app-api', 'basePath' => dirname(__DIR__), 'controllerNamespace' => 'api\controllers', ]
打開apiconfigmain.php開啟url路由美化規(guī)則
'urlManager' => [
'enablePrettyUrl' => true,
'showScriptName' => false,
'rules' => [
],
],
打開commonconfigbootstrap.php添加以下別名
Yii::setAlias('@api', dirname(dirname(__DIR__)) . '/api');
為什么要單獨(dú)創(chuàng)建API應(yīng)用
單獨(dú)創(chuàng)建API應(yīng)用，目的是便于維護(hù)，可以避免以下問題
- 配置的沖突
- 控制器的命名不便
- url美化規(guī)則沖突
- 分工明確frontend為前臺目錄；backend為后臺目錄；api為api目錄
接下來打開 apicontrollers 新建一個(gè)User控制器，繼承 yiirestActiveController，命名為 UserController,代碼如下：
<?php
namespace api\controllers;
use yii\rest\ActiveController;
class UserController extends ActiveController
{
public $modelClass = 'common\models\User';
}
配置URL規(guī)則
為剛才的 user控制器添加url美化規(guī)則
打開 apiconfigmain.php 修改 components屬性，添加下列代碼:
...
'urlManager' => [
'enablePrettyUrl' => true,
'enableStrictParsing' => true,
'showScriptName' => false,
'rules' => [
['class' => 'yii\rest\UrlRule',
'controller' => 'user'
],
],
]
...
ok，到此就成了一個(gè) 符合 RESTful 風(fēng)格的API
看起來在控制器了什么也沒有寫，只是指定了一個(gè)模型，但是她的背后完成了很多的功能哦，列表如下：
- GET /users: 逐頁列出所有用戶
- HEAD /users: 顯示用戶列表的概要信息
- POST /users: 創(chuàng)建一個(gè)新用戶
- GET /users/123: 返回用戶 123 的詳細(xì)信息
- HEAD /users/123: 顯示用戶 123 的概述信息
- PATCH /users/123: and PUT /users/123: 更新用戶123
- DELETE /users/123: 刪除用戶123
- OPTIONS /users: 顯示關(guān)于末端 /users 支持的動詞
- OPTIONS /users/123: 顯示有關(guān)末端 /users/123 支持的動詞
如何訪問呢
你可以使用 curl命令進(jìn)行訪問,命令如下:
curl -i -H "Accept:application/json" http://localhost/users
命令行下還是比較麻煩的，也不方便測試，推薦使用 API測試工具
這類的工具有很多，我就不一一列舉了，這里推薦 Postman,很好很強(qiáng)大，Chorme也有插件，可以安裝，這里我推薦直接下載軟件安裝調(diào)試，比較方便
你可能發(fā)現(xiàn)了 訪問任何路由地址都是加的s,users ， 為什么呢? 資源，你要理解 資源二字，既然是資源肯定是個(gè)集合，肯定有一大堆，所以要加上復(fù)數(shù)，我是這么理解的。
你說我就是不想加上s,我就想采用http://localhost/user 這種方式來進(jìn)行訪問，好吧，可以，滿足你，只是不推薦
繼續(xù)打開配置文件apiconfigmain.php修改剛才添加的 urlManager 如下:
'urlManager' => [
'enablePrettyUrl' => true,
'enableStrictParsing' => true,
'showScriptName' => false,
'rules' => [
['class' => 'yii\rest\UrlRule',
'controller' => 'user',
'pluralize' => false, //設(shè)置為false 就可以去掉復(fù)數(shù)形式了
],
],
]
加入 'pluralize' => false, 就表示去掉復(fù)數(shù)形式了，再次強(qiáng)調(diào)不推薦
ok，在控制器中我們沒有寫任何一句代碼，他就給我們生成許多方法，但是有時(shí)候我們可能需要修改一些代碼，來達(dá)到我們想要的效果，比如連表查詢，然后再返回?cái)?shù)據(jù)
接下來我們就實(shí)現(xiàn)這樣的功能:
打開剛才新建的user控制器, 重寫 action方法:
<?php
namespace api\controllers;
use yii\rest\ActiveController;
class UserController extend extends ActiveController
{
public $modelClass = 'common\models\User';
public function actions()
{
$action= parent::actions(); // TODO: Change the autogenerated stub
unset($action['index']);
unset($action['create']);
unset($action['update']);
unset($action['delete']);
}
public function actionIndex()
{
//你的代碼
}
}
這樣我們就可以重寫他的代碼了。哈哈
我們再新建一個(gè)自己的 action
<?php
namespace api\controllers;
use yii\rest\ActiveController;
class UserController extends ActiveController
{
public $modelClass = 'common\models\User';
public function actions()
{
$action= parent::actions(); // TODO: Change the autogenerated stub
unset($action['index']);
unset($action['create']);
unset($action['update']);
unset($action['delete']);
}
public function actionIndex()
{
//你的代碼
}
public function actionTest() //假如是get請求
{
//業(yè)務(wù)邏輯
}
}
然后試著訪問一下 http://localhost/users/test，報(bào)錯(cuò)？找不到？
報(bào)錯(cuò)就對了，那是因?yàn)槲覀儧]有設(shè)置其他路由訪問
修改 apiconfigmain.php
'urlManager' => [
'enablePrettyUrl' => true,
'enableStrictParsing' => true,
'showScriptName' => false,
'rules' => [
['class' => 'yii\rest\UrlRule',
'controller' => 'user',
//'pluralize' => false, //設(shè)置為false 就可以去掉復(fù)數(shù)形式了
'extraPatterns'=>[
'GET send-email'=>'test'
],
],
],
]
接下來重新訪問就沒有問題了，ps：你自己編寫的任何 action 都要在 extraPatterns 進(jìn)行配置
以上就是本文的全部內(nèi)容，希望對大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。
相關(guān)文章
這篇文章主要介紹了PHP兩種去掉數(shù)組重復(fù)值的方法比較,分別是foreach方法和array_unique方法,需要的朋友可以參考下2014-06-06
基于curl數(shù)據(jù)采集之正則處理函數(shù)get_matches的使用
本篇文章介紹了，基于curl數(shù)據(jù)采集之正則處理函數(shù)get_matches的使用。需要的朋友參考下2013-04-04
最近新開發(fā)個(gè)項(xiàng)目基于微信二維碼來實(shí)現(xiàn)公司簽到業(yè)務(wù)需求，需要做哪些相關(guān)配置呢，接下來通過本文給大家詳細(xì)介紹下，對php二維碼簽到功能感興趣的朋友一起學(xué)習(xí)下吧2021-05-05
遍歷指定目錄，并存儲目錄內(nèi)所有文件屬性信息的php代碼
本篇文章主要介紹了PHP遍歷指定目錄，并存儲目錄內(nèi)所有文件屬性信息，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下。2016-10-10
這篇文章主要介紹了Laravel5框架添加自定義輔助函數(shù)的方法,簡單說明了Laravel5中添加自定義輔助函數(shù)的具體步驟,包括輔助函數(shù)定義、載入、編譯等相關(guān)操作技巧,需要的朋友可以參考下2018-08-08
這篇文章主要介紹了利用http協(xié)議發(fā)布博客園博文評論的方法，首先，大家要明確給博文提交評論的實(shí)質(zhì)就是通過http協(xié)議服務(wù)器發(fā)送一個(gè)post請求,需要的朋友可以參考下2015-08-08
這篇文章主要介紹了yii2緩存Caching基本用法,結(jié)合實(shí)例形式分析了Yii2中緩存的配置、設(shè)置、讀取及判斷等基本用法,需要的朋友可以參考下2016-07-07
php實(shí)現(xiàn)的IMEI限制的短信驗(yàn)證碼發(fā)送類
本文給大家分享的是可以檢驗(yàn)手機(jī)號碼與IMEI的短信驗(yàn)證碼發(fā)送的php類，十分的實(shí)用，這里推薦給大家，有需要的小伙伴可以參考下。2015-05-05
tp5.1 實(shí)現(xiàn)setInc字段自動加1
今天小編就為大家分享一篇tp5.1 實(shí)現(xiàn)setInc字段自動加1示例，具有很好的參考價(jià)值，希望對大家有所幫助。一起跟隨小編過來看看吧2019-10-10
php如何修改SESSION的生存存儲時(shí)間的實(shí)例代碼
本篇文章主要介紹了php如何修改SESSION的生存時(shí)間的實(shí)例代碼，小編覺得挺不錯(cuò)的，現(xiàn)在分享給大家，也給大家做個(gè)參考。一起跟隨小編過來看看吧2017-07-07