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

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

我們提供的服務(wù)有：成都網(wǎng)站制作、網(wǎng)站建設(shè)、微信公眾號(hào)開發(fā)、網(wǎng)站優(yōu)化、網(wǎng)站認(rèn)證、點(diǎn)軍ssl等。為1000+企事業(yè)單位解決了網(wǎng)站和推廣的問題。提供周到的售前咨詢和貼心的售后服務(wù)，是有科學(xué)管理、有技術(shù)的點(diǎn)軍網(wǎng)站制作公司

安裝yii2.0


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

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

初始化高級(jí)模板


cd advanced
./init

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


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');

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


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

  • 配置的沖突

  • 控制器的命名不便

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

  • 分工明確frontend為前臺(tái)目錄；backend為后臺(tái)目錄；api為api目錄

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

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

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

配置URL規(guī)則


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


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

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

...

ok，到此就成了一個(gè) 符合 RESTful 風(fēng)格的API


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

  • GET /users: 逐頁列出所有用戶

  • HEAD /users: 顯示用戶列表的概要信息

  • POST /users: 創(chuàng)建一個(gè)新用戶

  • GET /users/123: 返回用戶 123 的詳細(xì)信息

  • HEAD /users/123: 顯示用戶 123 的概述信息

  • PATCH /users/123: and PUT /users/123: 更新用戶123

  • DELETE /users/123: 刪除用戶123

  • OPTIONS /users: 顯示關(guān)于末端 /users 支持的動(dòng)詞

  • OPTIONS /users/123: 顯示有關(guān)末端 /users/123 支持的動(dòng)詞

如何訪問呢


你可以使用 curl命令進(jìn)行訪問,命令如下:

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

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

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

你可能發(fā)現(xiàn)了 訪問任何路由地址都是加的s,users ， 為什么呢? 資源，你要理解 資源二字，既然是資源肯定是個(gè)集合，肯定有一大堆，所以要加上復(fù)數(shù)，我是這么理解的。

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

繼續(xù)打開配置文件apiconfigmain.php修改剛才添加的 urlManager 如下:

'urlManager' => [
  'enablePrettyUrl' => true,
  'enableStrictParsing' => true,
  'showScriptName' => false,
  'rules' => [
    ['class' => 'yii\rest\UrlRule', 
    'controller' => 'user',
    'pluralize' => false,  //設(shè)置為false 就可以去掉復(fù)數(shù)形式了
    ],
  ],
]

加入 'pluralize' => false, 就表示去掉復(fù)數(shù)形式了，再次強(qiáng)調(diào)不推薦

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

接下來我們就實(shí)現(xiàn)這樣的功能:

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

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

我們?cè)傩陆ㄒ粋€(gè)自己的 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請(qǐng)求
  {
    //業(yè)務(wù)邏輯
  }
  
}

然后試著訪問一下 http://localhost/users/test，報(bào)錯(cuò)？找不到？

報(bào)錯(cuò)就對(duì)了，那是因?yàn)槲覀儧]有設(shè)置其他路由訪問

修改 apiconfigmain.php

'urlManager' => [
  'enablePrettyUrl' => true,
  'enableStrictParsing' => true,
  'showScriptName' => false,
  'rules' => [
    ['class' => 'yii\rest\UrlRule', 
    'controller' => 'user',
    //'pluralize' => false,  //設(shè)置為false 就可以去掉復(fù)數(shù)形式了
    'extraPatterns'=>[
      'GET send-email'=>'test'
    ],
    ],
  ],
]

關(guān)于如何在Yii2.0中配置RESTful API 問題的解答就分享到這里了，希望以上內(nèi)容可以對(duì)大家有一定的幫助，如果你還有很多疑惑沒有解開，可以關(guān)注創(chuàng)新互聯(lián)行業(yè)資訊頻道了解更多相關(guān)知識(shí)。

分享題目：如何在Yii2.0中配置RESTfulAPI-創(chuàng)新互聯(lián)
文章出自：http://bm7419.com/article30/diceso.html

成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián)，為您提供建站公司、域名注冊(cè)、外貿(mào)網(wǎng)站建設(shè)、品牌網(wǎng)站制作、電子商務(wù)、商城網(wǎng)站

廣告

聲明：本網(wǎng)站發(fā)布的內(nèi)容（圖片、視頻和文字）以用戶投稿、用戶轉(zhuǎn)載內(nèi)容為主，如果涉及侵權(quán)請(qǐng)盡快告知，我們將會(huì)在第一時(shí)間刪除。文章觀點(diǎn)不代表本網(wǎng)站立場(chǎng)，如需處理請(qǐng)聯(lián)系客服。電話：028-86922220；郵箱：631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載，或轉(zhuǎn)載時(shí)需注明來源： 創(chuàng)新互聯(lián)

成都seo排名網(wǎng)站優(yōu)化