如何使用MixPHP來開發API介面

這篇文章主要介紹了關於如何使用MixPHP來開發API介面，有著一定的參考價值，現在分享給大家，有需要的朋友可以參考一下

MixPHP 是一款基於 Swoole 的常駐記憶體型 PHP 高效能架構，架構的高效能特點非常適合開發 API 介面，而且 MixPHP 非常接近傳統 MVC 架構，所以開發介面時非常簡單。

下面做一個開發 API 介面的簡單一實例：

從 articles 表，通過 id 擷取一篇文章。

訪問該介面的 URL：

http://www.e.com/articles/details?id=1

資料庫表結構如下：

CREATE TABLE `articles` (  `id` int(10) unsigned NOT NULL AUTO_INCREMENT,  `title` varchar(255) NOT NULL,  `content` varchar(255) NOT NULL,  `dateline` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,  PRIMARY KEY (`id`)) ENGINE=InnoDB DEFAULT CHARSET=utf8;

第一步

修改資料庫設定檔，MixPHP 的應用設定檔中，關於資料庫的資訊都引用了 common/config/database.php 檔案。

第二步

修改應用設定檔:

• 修改 Response 組件預設輸出格式為 JSON 格式。

• 修改 404/500 錯誤輸出格式為 JSON 格式。

架構預設的 404/500 響應是網頁，而 API 服務需要響應 JSON 資料，通常其他傳統 MVC 架構需要修改很多地方才可完成這個需求，MixPHP 本身就提供該種配置，只需修改一下配置即可。

MixPHP 的預設 Web 應用程式中有兩個設定檔，分別為：

• main.php ： 部署在 mix-httpd 時使用。

• main_compatible.php ：部署在 Apache/PHP-FPM 時使用。

開發 API 時我們推薦在 Apache/PHP-FPM 下開發，上線再部署至 mix-httpd 即可，反正是無縫切換的。

現在我們修改 response 鍵名下的 defaultFormat 鍵為 mix\http\Error::FORMAT_JSON，如下：

// 響應'response' => [    // 類路徑    'class'         => 'mix\http\compatible\Response',    // 預設輸出格式    'defaultFormat' => mix\http\Response::FORMAT_JSON,    // json    'json'          => [        // 類路徑        'class' => 'mix\http\Json',    ],    // jsonp    'jsonp'         => [        // 類路徑        'class' => 'mix\http\Jsonp',        // callback鍵名        'name'  => 'callback',    ],    // xml    'xml'           => [        // 類路徑        'class' => 'mix\http\Xml',    ],],

然後修改 main_compatible.php 檔案中 error 鍵名下的 format 鍵為 mix\http\Error::FORMAT_JSON，如下：

// 錯誤'error'    => [    // 類路徑    'class'  => 'mix\http\Error',    // 輸出格式    'format' => mix\http\Error::FORMAT_JSON,],

第三步

建立控制器：

apps/index/controllers/ArticlesController.php

<?phpnamespace apps\index\controllers;use mix\facades\Request;use mix\http\Controller;use apps\index\messages\ErrorCode;use apps\index\models\ArticlesForm;class ArticlesController extends Controller{    public function actionDetails()    {        // 使用模型        $model             = new ArticlesForm();        $model->attributes = Request::get();        $model->setScenario('actionDetails');        if (!$model->validate()) {            return ['code' => ErrorCode::INVALID_PARAM];        }        // 擷取資料        $data = $model->getDetails();        if (!$data) {            return ['code' => ErrorCode::ERROR_ID_UNFOUND];        }        // 響應        return ['code' => ErrorCode::SUCCESS, 'data' => $data];    }}

建立錯誤碼類：

apps/index/messages/ErrorCode.php

<?phpnamespace apps\index\messages;class ErrorCode{    const SUCCESS = 0;    const INVALID_PARAM = 100001;    const ERROR_ID_UNFOUND = 200001;}

建立表單驗證模型：

apps/index/models/ArticlesForm.php

<?phpnamespace apps\index\models;use mix\validators\Validator;use apps\common\models\ArticlesModel;class ArticlesForm extends Validator{    public $id;    // 規則    public function rules()    {        return [            'id' => ['integer', 'unsigned' => true, 'maxLength' => 10],        ];    }    // 情境    public function scenarios()    {        return [            'actionDetails' => ['required' => ['id']],        ];    }    // 擷取詳情    public function getDetails()    {        return (new ArticlesModel())->getRowById($this->id);    }}

建立資料表模型：

apps/common/models/ArticlesModel.php

<?phpnamespace apps\common\models;use mix\facades\RDB;class ArticlesModel{    const TABLE = 'articles';    // 擷取一行資料通過id    public function getRowById($id)    {        $sql = "SELECT * FROM `" . self::TABLE . "` WHERE id = :id";        $row = RDB::createCommand($sql)->bindParams([            'id' => $id,        ])->queryOne();        return $row;    }}

以上就是全部代碼的編寫。

第四步

使用 Postman 測試，如下：

介面開發與測試完成，是不是很簡單呀。

以上就是本文的全部內容，希望對大家的學習有所協助，更多相關內容請關注topic.alibabacloud.com！