如何在Yii2.0中配置RESTful API ？針對這個問題，這篇文章詳細介紹了相對應的分析和解答，希望可以幫助更多想解決這個問題的小伙伴找到更簡單易行的方法。

安裝yii2.0

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

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

初始化高級模板

cd advanced
./init

輸入"./init"后會出現(xiàn)以下內容

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 ...

修改數(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');

為什么要單獨創(chuàng)建API應用

單獨創(chuàng)建API應用，目的是便于維護，可以避免以下問題

• 配置的沖突

• 控制器的命名不便

• url美化規(guī)則沖突

• 分工明確frontend為前臺目錄；backend為后臺目錄；api為api目錄

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

配置URL規(guī)則

為剛才的 user控制器添加url美化規(guī)則

打開 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: 創(chuàng)建一個新用戶
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也有插件，可以安裝，這里我推薦直接下載軟件安裝調試，比較方便
你可能發(fā)現(xiàn)了 訪問任何路由地址都是加的s,users ， 為什么呢? 資源，你要理解 資源二字，既然是資源肯定是個集合，肯定有一大堆，所以要加上復數(shù)，我是這么理解的。
你說我就是不想加上s,我就想采用http://localhost/user 這種方式來進行訪問，好吧，可以，滿足你，只是不推薦
繼續(xù)打開配置文件apiconfigmain.php修改剛才添加的 urlManager 如下:
'urlManager' => [
  'enablePrettyUrl' => true,
  'enableStrictParsing' => true,
  'showScriptName' => false,
  'rules' => [
    ['class' => 'yii\rest\UrlRule', 
    'controller' => 'user',
    'pluralize' => false,  //設置為false 就可以去掉復數(shù)形式了
    ],
  ],
]
加入 'pluralize' => false, 就表示去掉復數(shù)形式了，再次強調不推薦
ok，在控制器中我們沒有寫任何一句代碼，他就給我們生成許多方法，但是有時候我們可能需要修改一些代碼，來達到我們想要的效果，比如連表查詢，然后再返回數(shù)據(jù)
接下來我們就實現(xiàn)這樣的功能:
打開剛才新建的user控制器, 重寫 action方法:
這樣我們就可以重寫他的代碼了。哈哈
我們再新建一個自己的 action
然后試著訪問一下 http://localhost/users/test，報錯？找不到？
報錯就對了，那是因為我們沒有設置其他路由訪問
修改 apiconfigmain.php
'urlManager' => [
  'enablePrettyUrl' => true,
  'enableStrictParsing' => true,
  'showScriptName' => false,
  'rules' => [
    ['class' => 'yii\rest\UrlRule', 
    'controller' => 'user',
    //'pluralize' => false,  //設置為false 就可以去掉復數(shù)形式了
    'extraPatterns'=>[
      'GET send-email'=>'test'
    ],
    ],
  ],
]
關于如何在Yii2.0中配置RESTful API 問題的解答就分享到這里了，希望以上內容可以對大家有一定的幫助，如果你還有很多疑惑沒有解開，可以關注創(chuàng)新互聯(lián)行業(yè)資訊頻道了解更多相關知識。
            

            文章名稱：如何在Yii2.0中配置RESTfulAPI-創(chuàng)新互聯(lián)            

            網(wǎng)站URL：http://weahome.cn/article/diceso.html