Yii2實現RESTful風格的API中要注意的坑有哪些呢

本篇文章給大家分享的是有關Yii2實現RESTful風格的API中要注意的坑有哪些呢，小編覺得挺實用的，因此分享給大家學習，希望大家閱讀完這篇文章后可以有所收獲，話不多說，跟著小編一起來看看吧。

Yii2實現RESTful風格的API的流程如下：
1、WEB前端（frontend）和后端（backend）的同級目錄，新建一個文件夾，命名api,api中文件完全復制一份原始的backend中文件即可

2、需要修改common\config\bootstrap.php文件，對新建的應用增加alias別名

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

3、保證你的web服務器開啟rewrite規則！配置apache或nginx!這里請google或百度下。
nginx中在conf文件夾中vhost.conf或nginx.conf中相關位置加入：

location / {
try_files $uri $uri/ /index.php$is_args$args;
}

apache中在對應的api/web（域名指向的服務器目錄中）加入.htaccess：

RewriteEngine on

RewriteCond %{REQUEST_FILENAME} !-d

RewriteCond %{REQUEST_FILENAME} !-f

RewriteRule . index.php

4、api應用程序美化路由（注意里面的括弧、名字的大小寫，類名習慣駝峰式，但是controller 對應的控制器名一定要小寫）
接著配置api/config/main.php文件

'urlManager' => [
'enablePrettyUrl' => true,
'showScriptName' => false,
'enableStrictParsing' => true,

        'rules' => [
            ['class'=>'yii\rest\UrlRule','controller'=>'article'],
        ],
    ],

如果擔心影響其他訪問地址（如gii無法連接）可以先注釋'enableStrictParsing' =>true,傳到服務器后開啟即可（增加安全性）

5、準備工作好啦，開始寫conroller與model：
在www根目錄-->common-->models中新建文件Article.php(可以使用Gii)

<?php

namespace common\models;

use Yii;

/**

• This is the model class for table "article".

• 
  

• @property int $id ID

• @property string $title 標題

• @property string $content 內容

• @property int $category_id 分類

• @property int $status 狀態

• @property int $created_by 創建人

• @property int $created_at 創建時間

• @property int $updated_at 最后修改時間
  */
  class Article extends \yii\db\ActiveRecord
  {
  /**

  /**

  /**

• @inheritdoc
  */
  public function attributeLabels()
  {
  return [
  'id' => 'ID',
  'title' => 'Title',
  'content' => 'Content',
  'category_id' => 'Category ID',
  'status' => 'Status',
  'created_by' => 'Created By',
  'created_at' => 'Created At',
  'updated_at' => 'Updated At',
  ];
  }
  }

• @inheritdoc
  */
  public function rules()
  {
  return [
  [['id', 'title', 'content'], 'required'],
  [['id', 'category_id', 'status', 'created_by', 'created_at', 'updated_at'], 'integer'],
  [['content'], 'string'],
  [['title'], 'string', 'max' => 512],
  ];
  }

• @inheritdoc
  */
  public static function tableName()
  {
  return 'article';
  }

然后在api中controllers中新建文件：ArticleController.php

<?php
namespace api\controllers;
use yii\rest\ActiveController;
use common\models\Article;
/**

• */
  class ArticleController extends ActiveController
  {

  // function __construct(argument)
  // {
  //  # code...
  // }
  public $modelClass='\common\models\Article';
  }

6、訪問鏈接查看接口返回值：
http://www.xxx.com/articles  已經能夠很方便的獲取我們表中的數據了。
當然，yii2還對該api封裝了如下操作：

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

以上就是Yii2實現RESTful風格的API中要注意的坑有哪些呢，小編相信有部分知識點可能是我們日常工作會見到或用到的。希望你能通過這篇文章學到更多知識。更多詳情敬請關注億速云行業資訊頻道。