Yii2 RESTful API 的詳細使用

做者：白狼
出處：http://www.manks.top/yii2_restful_api.html
本文版權歸做者，歡迎轉載，但未經做者贊成必須保留此段聲明，且在文章頁面明顯位置給出原文鏈接，不然保留追究法律責任的權利。

什麼是RESTful風格的API？

對於各類客戶端設備與服務端的通訊，咱們每每都經過API爲客戶端提供數據，提供某種資源。關於RESTful的概念，一查一大推，一兩句也解釋不清，姑且先按照咱們通俗的理解：在衆多風格、衆多原則的API中，RESTful就是一套比較優秀的接口調用方式。

Yii2如何實現RESTful風格的API？

一、創建單獨的應用程序

爲了增長程序的可維護性，易操做性，咱們選擇新建一套應用程序，這也是爲了和前臺應用、後臺應用區分開操做。有些人要嚷嚷了，爲啥非得單獨搞一套呢？若是你就單純的提供個別的幾個h5頁面的話，那就沒有必要了，但事實每每是客戶端要升級啊，要增長不一樣的版本啊，這就須要咱們不但要後端不只要增長一套單獨的應用程序，咱們還要增長各類版本去控制。

在WEB前端（frontend）和後端（backend）的同級目錄，新建一個文件夾，命名api,其目錄結構以下所示：

├─assets
│      AppAsset.php
├─config
│      bootstrap.php
│      main-local.php
│      main.php
│      params-local.php
│      params.php
├─runtime
└─web
    │ index.php
    ├─assets
    └─css

能夠看出其目錄結構基本上同backend沒有其餘差別，由於咱們就是拷貝backend項目，只是作了部分優化。

二、爲新建的api應用程序美化路由

首先保證你的web服務器開啓rewrite規則，細節咱們就不說了，不過這是前提。

接着配置api/config/main.php文件

'components' => [
    // other config
    'urlManager' => [
        'enablePrettyUrl' => true,
        'showScriptName' => false,
        'enableStrictParsing' =>true,
        'rules' => [],
    ]
],

最後只須要在應用入口同級增長.htaccess文件就好，咱們以apache爲例

Options +FollowSymLinks
IndexIgnore */*

RewriteEngine on

# if a directory or a file exists, use it directly
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d

# otherwise forward it to index.php
RewriteRule . index.php

RewriteRule \.svn\/  /404.html
RewriteRule \.git\/  /404.html

三、利用gii生成測試modules

用了便於演示說明，咱們新建一張數據表goods表，並向其中插入幾條數據。

CREATE TABLE `goods` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `name` varchar(100) NOT NULL DEFAULT '',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

INSERT INTO `goods` VALUES ('1', '11111');
INSERT INTO `goods` VALUES ('2', '22222');
INSERT INTO `goods` VALUES ('3', '333');
INSERT INTO `goods` VALUES ('4', '444');
INSERT INTO `goods` VALUES ('5', '555');

接着咱們先利用gii生成modules後，再利用gii模塊，按照下圖中生成goods信息

（圖片參考原文）

如今，咱們的api目錄結構應該多個下面這幾個目錄

│
├─models
│      Goods.php
│
├─modules
│  └─v1
│      │  Module.php
│      │
│      ├─controllers
│      │      DefaultController.php
│      │      GoodsController.php
│      │
│      └─views
│          └─default
│                  index.php

四、從新配置控制器

爲了實現restful風格的api,在yii2中，咱們須要對控制器進行一下改寫

<?php

namespace api\modules\v1\controllers;

use yii\rest\ActiveController;

class GoodsController extends ActiveController
{
    public $modelClass = 'api\models\Goods';
}

五、爲Goods配置Url規則

'rules' => [
    [
        'class' => 'yii\rest\UrlRule',
        'controller' => ['v1/goods']
    ],
]

六、模擬請求操做

通過上面幾個步驟，到此咱們已經爲goods成功建立了知足restful風格的api了。爲了更好更方便的演示，咱們藉助工具postman進行模擬請求。

爲了見證一下咱們的操做，咱們用postman請求一下GET /v1/goods看看結果如何：

（postman截圖見原文）

從上面截圖中能夠清楚的看到，GET /v1/goods 已經可以很方便的獲取咱們表中的數據了。

固然，yii2還對該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 支持的動詞

不信的話咱們能夠利用postman發送一個post請求到/v1/goods,咱們會發現成功建立了一個新的商品。

須要提醒的是，操做中還請細心且注意：

若是你的控制器末端不是複數（好比是blog非blogs）請保證請求的時候是複數！這是由於在RESTful架構中，網址中只能有名詞而不能包含動詞，名詞又每每與數據表相對應，數據表呢又是一個「集合」，所以該名詞每每是複數的形式。

七、關於受權認證

考慮目前國內網站大部分採集文章十分頻繁，更有甚者不註明原文出處，原做者更但願看客們查看原文，以防有任何問題不能更新全部文章，避免誤導！