Yii2 使用 RESTful？其實 Yii2 框架本身就對 RESTful 是友好支持的，具體可以看官方文檔(http://www.yiichina.com/doc/guide/2.0/rest-quick-start)，或者去看源碼，都是可以的 注意: 我們使用resTful的同時,需要借助于測試工具進行地址訪問,例如: 谷歌的PostMAN,火狐的HttpRequester工具來訪問 創建一個控制器 我的工作目錄如圖所示 (首先， 參照下面的目錄圖片,可以看出,我創建了兩個大的文件夾,v1,v2,目的是測試訪問不同版本的接口)下面以v2中的文件為例:創建一個控制器類 api\modules\v2\UserController 如下， [php] view plain copy在CODE上查看代碼片派生到我的代碼片namespace api\modules\v2\controllers; use yii\rest\ActiveController; class UserController extends ActiveController { public $modelClass = 'api\modules\v2\models\user\UserBaseInfo'; } 控制器類擴展自 yii\rest\ActiveController。通過指定 yii\rest\ActiveController::modelClass作為 api\modules\v2\models\user\UserBaseInfo， 控制器就能知道使用哪個模型去獲取和處理數據。配置URL規則修改有關在應用程序配置的urlManager組件的配置:[php] view plain copy在CODE上查看代碼片派生到我的代碼片'urlManager' => [ 'enablePrettyUrl' => true, 'enableStrictParsing' => true, 'showScriptName' => false, 'rules' => [ ['class' => 'yii\rest\UrlRule', 'controller' => 'user'], ], ] 說明: a): 上面的配置主要是為user控制器增加一個 URL 規則。這樣，用戶的數據就能通過美化的 URL 和有意義的 http 動詞進行訪問和操作。b): 上面是沒有加上版本的url配置,至于關于版本我將以新的一篇來說明.配置另外的: [php] view plain copy在CODE上查看代碼片派生到我的代碼片'controllerNamespace' => 'api\controllers', 'components' => [ 'user' => [ 'identityClass' => 'api\modules\v1\models\oauth\AccessToken', 'enableAutoLogin' => true, 'enableSession' => false, 'loginUrl' => null ], 嘗試隨著以上所做的最小的努力，你已經完成了創建用于訪問用戶數據的 RESTful 風格的 API。你所創建的 API 包括：相比于URL管理的Web應用程序，上述主要的新東西是通過RESTful API請求yii\rest\UrlRule。這個特殊的URL規則類將會建立一整套子URL規則來支持路由和URL創建的指定的控制器。例如， 上面的代碼中是大致按照下面的規則:['PUT,PATCH users/<id>' => 'user/update','DELETE users/<id>' => 'user/delete','GET,HEAD users/<id>' => 'user/view','POST users' => 'user/create','GET,HEAD users' => 'user/index','users/<id>' => 'user/options','users' => 'user/options', ]GET /users: 逐頁列出所有用戶HEAD /users: 顯示用戶列表的概要信息POST /users: 創建一個新用戶GET /users/123: 返回用戶 123 的詳細信息HEAD /users/123: 顯示用戶 123 的概述信息PATCH /users/123 and PUT /users/123: 更新用戶123DELETE /users/123: 刪除用戶123OPTIONS /users: 顯示關于末端 /users 支持的動詞OPTIONS /users/123: 顯示有關末端 /users/123 支持的動詞補充：Yii 將在末端使用的控制器的名稱自動變為復數。（譯注：個人感覺這里應該變為注意）經過上面的配置后,你會看到你的控制類繼承的是yii\rest\ActiveController,如果你進這個文件后,你會看到下面這些方法:[php] view plain copy在CODE上查看代碼片派生到我的代碼片public function actions() { return [ 'index' => [ 'class' => 'yii\rest\IndexAction', 'modelClass' => $this->modelClass, 'checkAccess' => [$this, 'checkAccess'], ], 'view' => [ 'class' => 'yii\rest\ViewAction', 'modelClass' => $this->modelClass, 'checkAccess' => [$this, 'checkAccess'], ], 'create' => [ 'class' => 'yii\rest\CreateAction', 'modelClass' => $this->modelClass, 'checkAccess' => [$this, 'checkAccess'], 'scenario' => $this->createScenario, ], 'update' => [ 'class' => 'yii\rest\UpdateAction', 'modelClass' => $this->modelClass, 'checkAccess' => [$this, 'checkAccess'], 'scenario' => $this->updateScenario, ], 'delete' => [ 'class' => 'yii\rest\DeleteAction', 'modelClass' => $this->modelClass, 'checkAccess' => [$this, 'checkAccess'], ], 'options' => [ 'class' => 'yii\rest\OptionsAction', ], ]; } /** * @inheritdoc */ protected function verbs() { return [ 'index' => ['GET', 'HEAD'], 'view' => ['GET', 'HEAD'], 'create' => ['POST'], 'update' => ['PUT', 'PATCH'], 'delete' => ['DELETE'], ]; } 從上面的方法我們可以知道,如果在你使用yii框架自帶的方法時,它默認有create, delete, update, index, view等的一下方法所創建的 API 包括：GET /users: 逐頁列出所有用戶POST /users: 創建一個新用戶GET /users/123: 返回用戶 123 的詳細信息PATCH /users/123 and PUT /users/123: 更新用戶123DELETE /users/123: 刪除用戶123但是如果你要是不想用他的某些方法,我們可以通過下面的方法來自己覆蓋對應的方法例如: [php] view plain copy在CODE上查看代碼片派生到我的代碼片public function actions() { $actions = parent::actions(); // 注銷系統自帶的實現方法 unset($actions['index']); //unset($actions['create']); //unset($actions['update']); //unset($actions['delete']); return $actions; } //覆蓋父類的actionIndex方法,并進行重寫 public function actionIndex() { //獲取用戶所有信息 ...... } 對于其他的方法同上....于是我們就可以通過方法地址獲取想要的數據:GET http://www.api.com/users

?

轉載于:https://www.cnblogs.com/zhangtianle/p/8467315.html

創作挑戰賽新人創作獎勵來咯，堅持創作打卡瓜分現金大獎

總結

以上是生活随笔為你收集整理的Yii2 使用 RESTful 写API接口 实例的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。