API接口開發 配置、實現、測試


Yii2 基於RESTful架構的 advanced版API接口開發 配置、實現、測試

環境配置:

開啟服務器偽靜態

本處以apache為例,查看apache的conf目錄下httpd.conf,找到下面的代碼

LoadModule rewrite_module modules/mod_rewrite.so

將其前面的#去掉,如果沒有找到則添加進去。

找到一下代碼

<Directory "C:/phpStudy/Apache/cgi-bin">
    AllowOverride All
    Options None
    Require all granted
</Directory>

將原本的AllowOverride None改為AllowOverride All。

然后在站點根目錄下創建一個.htaccess文件,內容如下:

  .htaccess

此處不再贅述yii2的配置,如果需要可以看YII2實戰手冊

YII2實際操作:

1、配置URL規則及modules

(1)新建modules文件夾,實行api接口版本控制。例如V1版本、V2版本……

在v1文件夾下新建controllers文件夾(控制器)、models文件夾(模型)、Module.php配置文件。

Module.php文件如下:

復制代碼
 1 <?php
 2 namespace api\modules\v1;
 3 
 4 class Module extends \yii\base\Module
 5 {
 6 
 7     public $controllerNamespace = 'api\modules\v1\controllers';
 8 
 9     public function init()
10     {
11         parent::init();
12     }
13 }
復制代碼

第2行和第7行隨版本擴展而變化(v1->v2...)。

(2)配置config文件夾下的main.php文件

  main.php

注意10~17行、20~44行的組件配置,相信大家仔細閱讀就能明白,此處不再贅述原理,請大家尤其注意33~35行的代碼,此處表示的是v1/site控制器,隨着接口控制器的增多,可以直接在數組中增加即可。本文力求快速配置出RESTful架構的實現。

(3)v2、v3表示以后的版本變化,配置都類似於v1文件夾。

2、創建一個模型

數據庫准備一個名為mxq_guide的數據表

復制代碼
CREATE TABLE `mxq_guide` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `imgurl` varchar(255) DEFAULT NULL COMMENT '圖片路徑', 
`status` int(11) DEFAULTNULL COMMENT '1啟用 0禁用',
`flag` int(11) DEFAULTNULL COMMENT '1安卓 2蘋果',
PRIMARY KEY (`id`)
) ENGINE=MyISAM AUTO_INCREMENT=24 DEFAULT CHARSET=utf8 COMMENT='APP導航圖';
復制代碼

創建后請注意及時往數據庫添加幾條數據信息。

通過腳手架gii來創建guide.php模型(使用方法請看yii2權威指南)。生成后的文件注意改寫,修改為如下形式以滿足RESTful的需求。之后從models文件夾中轉移到v1/models文件夾中,並注意命名空間的修改。

  guide.php

3、創建一個控制器

  SiteController.php

控制器請創建在modules/controllers文件夾下,並注意命名空間的修改。

要注意的是,此處的控制器與普通的控制器繼承Controller不同,此處需繼承ActiveController類。

20~30行注釋的代碼是基於RESTful架構的access_token認證,目前還未測試通過,后續補充。

至此,基於YII2的所有配置已基本完成,接下來介紹api接口測試工具及方法。

RESTful的測試工具PostMAN:

 首先介紹一下postman這款插件,是基於谷歌瀏覽器的一款模擬請求的實用插件。具體使用,在下面測試過程中涉及截圖,介紹不足之處請見諒,自己也是第一次使用。

推薦使用上面的APP版本,便於后續封裝自己寫好的api接口,下面的是網頁版本。

YII2支持的RESTful有四種請求方式:GET查看信息,POST創建信息,PUT更新信息,DELETE刪除信息。

下面開始演示四種請求數據的方式。(只是截圖演示效果,具體使用還需要大家自己去摸索。)

此處演示的是GET方法請求數據庫的數據。對應的是modules/controllers/SiteController/actionIndex方法。

請大家注意最上面方框內的URL地址,rest默認將控制器進行復數請求http://api.mxq.com/v1/sites,此處就是rest的默認規則。

打*星號位置顯示的是正常的效果,如若出現錯誤,大家可以去YII權威指南——錯誤檢查錯誤原因。

YII2的ActiveController默認實現了數據的分頁效果。

此處演示的是POST方法新建數據庫的數據。對應的是modules/controllers/SiteController/actionCreate方法。

如果在數據庫的數據層寫好數據校驗規則,此處提交數據不滿足要求的時候就會顯示相應的錯誤。這也是REST的優勢之一。比如如下情況,flag我定義的是int型:

接下來演示的是PUT方法更新數據庫的數據。對應的是modules/controllers/SiteController/actionUpdate方法。

此處請大家再次注意最上面的URL:http://api.mxq.com/v1/sites/15  此處15代表的是數據庫id為15的數據,表示更新數據庫ID為15的數據信息。請大家一定注意。RESTful在使用更新和刪除數據操作的時候,id不能一表單的形式提交,必須緊跟在URL之后。

接下來演示的是DELETE方法刪除數據庫的數據。對應的是modules/controllers/SiteController/actionDelete方法。

當返回值為1的時候表示的就是刪除操作執行成功。具體原理請大家仔細觀察sitecontroller控制器內的函數。


以上就是基於yii2的RESTful的一些簡單介紹、實現方法以及測試結果。有什么不正確或遺漏的地方,歡迎大家來補充。后續也會在此基礎上進行更新。本人第一次接觸yii2框架和RESTful架構,表述如有不對之處,請大家見諒。

 

 
 
標簽:  PHPRESTfulYII2POSTMAN


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM