国产探花免费观看_亚洲丰满少妇自慰呻吟_97日韩有码在线_资源在线日韩欧美_一区二区精品毛片,辰东完美世界有声小说,欢乐颂第一季,yy玄幻小说排行榜完本

首頁 > 語言 > PHP > 正文

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

2024-05-05 00:06:02
字體:
來源:轉載
供稿:網友

最近在做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,代碼如下:

<?phpnamespace 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方法:

<?phpnamespace 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

<?phpnamespace 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 進行配置

以上就是本文的全部內容,希望對大家的學習有所幫助,也希望大家多多支持VeVb武林網。


注:相關教程知識閱讀請移步到PHP教程頻道。
發表評論 共有條評論
用戶名: 密碼:
驗證碼: 匿名發表

圖片精選

主站蜘蛛池模板: 安吉县| 滨州市| 伊川县| 文昌市| 柘荣县| 辽阳县| 凉城县| 五寨县| 铜鼓县| 萝北县| 武宣县| 朔州市| 济南市| 阳谷县| 晋江市| 和静县| 平乡县| 隆德县| 淮滨县| 睢宁县| 内丘县| 瑞昌市| 汉中市| 紫金县| 嘉荫县| 兴文县| 晋城| 海安县| 河池市| 桑日县| 青海省| 邢台市| 吉木萨尔县| 岱山县| 闽侯县| 应用必备| 平乐县| 正镶白旗| 成都市| 丹凤县| 如皋市|