Yii2.0 RESTful API 基礎配置教程詳解

這篇文章主要介紹了Yii2.0 RESTful API 基礎配置教程,小編覺得挺不錯的，現在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧

最近在做Yii2.0 RESTful API功能，找了好久的資料，才找到這類的教程，感謝該作者，以下內容根據我的項目實際情況做了一定的修改。

安裝yii2.0

安裝 Composer 後，您可以通過在 Web 可訪問的文件夾下運行以下命令來 安裝Yii應用程序模板：

composer create-project --prefer-dist yiisoft/yii2-app-basic basic

初始化高級模板

cd advanced
./init

輸入"./init"後會出現以下內容

Yii Application Initialization Tool v1.0

Which environment do you want the application to be initialized in?

  [0] Development
  [1] Production

  Your choice [0-1, or "q" to quit] 0

  Initialize the application under 'Development' environment? [yes|no] yes

  Start initialization ...

修改數據庫連接屬性

打開 commonconfigmain-local.php,配置數據庫連接信息

'db' => [
      'class' => 'yii\db\Connection',
      'dsn' => 'mysql:host=127.0.0.1;dbname=yii',
      'username' => 'root',
      'password' => 'root',
      'charset' => 'utf8',
    ],

執行 migrate 數據庫遷移

./yii migrate

拷貝backend目錄，命名爲api

打開apiconfigmain.php 修改id,controllerNamespace等，將所有backend替換爲api：

return [
  'id' => 'app-api',
  'basePath' => dirname(__DIR__),
  'controllerNamespace' => 'api\controllers',
]

打開apiconfigmain.php開啓url路由美化規則

'urlManager' => [
      'enablePrettyUrl' => true,
      'showScriptName' => false,
      'rules' => [
      ],
    ],

打開commonconfigbootstrap.php添加以下別名

Yii::setAlias('@api', dirname(dirname(__DIR__)) . '/api');

爲什麼要單獨創建API應用

單獨創建API應用，目的是便於維護，可以避免以下問題

• 配置的衝突
• 控制器的命名不便
• url美化規則衝突
• 分工明確frontend爲前臺目錄；backend爲後臺目錄；api爲api目錄

接下來打開 apicontrollers 新建一個User控制器，繼承 yiirestActiveController，命名爲 UserController,代碼如下：

<?php
namespace api\controllers;
use yii\rest\ActiveController;

class UserController extends ActiveController
{
  public $modelClass = 'common\models\User';
  
}

配置URL規則

爲剛纔的 user控制器添加url美化規則

打開 apiconfigmain.php 修改 components屬性，添加下列代碼:

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

...

ok，到此就成了一個 符合 RESTful 風格的API

看起來在控制器了什麼也沒有寫，只是指定了一個模型，但是她的背後完成了很多的功能哦，列表如下：

• GET /users: 逐頁列出所有用戶
• HEAD /users: 顯示用戶列表的概要信息
• POST /users: 創建一個新用戶
• GET /users/123: 返回用戶 123 的詳細信息
• HEAD /users/123: 顯示用戶 123 的概述信息
• PATCH /users/123: and PUT /users/123: 更新用戶123
• DELETE /users/123: 刪除用戶123
• OPTIONS /users: 顯示關於末端 /users 支持的動詞
• OPTIONS /users/123: 顯示有關末端 /users/123 支持的動詞

如何訪問呢

你可以使用 curl命令進行訪問,命令如下:

curl -i -H "Accept:application/json" http://localhost/users

命令行下還是比較麻煩的，也不方便測試，推薦使用 API測試工具

這類的工具有很多，我就不一一列舉了，這裏推薦 Postman,很好很強大，Chorme也有插件，可以安裝，這裏我推薦直接下載軟件安裝調試，比較方便

你可能發現了 訪問任何路由地址都是加的s,users ， 爲什麼呢? 資源，你要理解 資源二字，既然是資源肯定是個集合，肯定有一大堆，所以要加上覆數，我是這麼理解的。

你說我就是不想加上s,我就想採用http://localhost/user 這種方式來進行訪問，好吧，可以，滿足你，只是不推薦

繼續打開配置文件apiconfigmain.php修改剛纔添加的 urlManager 如下:

'urlManager' => [
  'enablePrettyUrl' => true,
  'enableStrictParsing' => true,
  'showScriptName' => false,
  'rules' => [
    ['class' => 'yii\rest\UrlRule', 
    'controller' => 'user',
    'pluralize' => false,  //設置爲false 就可以去掉複數形式了
    ],
  ],
]

加入 'pluralize' => false, 就表示去掉複數形式了，再次強調不推薦

ok，在控制器中我們沒有寫任何一句代碼，他就給我們生成許多方法，但是有時候我們可能需要修改一些代碼，來達到我們想要的效果，比如連表查詢，然後再返回數據

接下來我們就實現這樣的功能:

打開剛纔新建的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()
  {
    //你的代碼
  }
  
}

這樣我們就可以重寫他的代碼了。哈哈

我們再新建一個自己的 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請求
  {
    //業務邏輯
  }
  
}

然後試着訪問一下 http://localhost/users/test，報錯？找不到？

報錯就對了，那是因爲我們沒有設置其他路由訪問

修改 apiconfigmain.php

'urlManager' => [
  'enablePrettyUrl' => true,
  'enableStrictParsing' => true,
  'showScriptName' => false,
  'rules' => [
    ['class' => 'yii\rest\UrlRule', 
    'controller' => 'user',
    //'pluralize' => false,  //設置爲false 就可以去掉複數形式了
    'extraPatterns'=>[
      'GET send-email'=>'test'
    ],
    ],
  ],
]

接下來重新訪問就沒有問題了，ps：你自己編寫的任何 action 都要在 extraPatterns 進行配置

以上就是本文的全部內容，希望對大家的學習有所幫助，也希望大家多多支持神馬文庫。