MixPHP 開發(fā) API 接口簡(jiǎn)單實(shí)例

weizx 發(fā)布于2019-06-28 18:31 / 1371人閱讀

摘要：注意這個(gè)是的范例是一款基于的常駐內(nèi)存型高性能框架，框架的高性能特點(diǎn)非常適合開發(fā)接口，而且非常接近傳統(tǒng)框架，所以開發(fā)接口時(shí)非常簡(jiǎn)單。下面做一個(gè)開發(fā)接口的簡(jiǎn)單實(shí)例從表，通過(guò)獲取一篇文章。第四步使用測(cè)試，如下接口開發(fā)與測(cè)試完成，是不是很簡(jiǎn)單呀。

注意：這個(gè)是 MixPHP V1 的范例

MixPHP 是一款基于 Swoole 的常駐內(nèi)存型 PHP 高性能框架，框架的高性能特點(diǎn)非常適合開發(fā) API 接口，而且非常接近傳統(tǒng) MVC 框架，所以開發(fā)接口時(shí)非常簡(jiǎn)單。

下面做一個(gè)開發(fā) API 接口的簡(jiǎn)單實(shí)例：

從 articles 表，通過(guò) id 獲取一篇文章。

訪問(wèn)該接口的 URL：

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

數(shù)據(jù)庫(kù)表結(jié)構(gòu)如下：

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;

第一步

修改數(shù)據(jù)庫(kù)配置文件，MixPHP 的應(yīng)用配置文件中，關(guān)于數(shù)據(jù)庫(kù)的信息都引用了 common/config/database.php 文件。

第二步

修改應(yīng)用配置文件:

修改 Response 組件默認(rèn)輸出格式為 JSON 格式。

修改 404/500 錯(cuò)誤輸出格式為 JSON 格式。

框架默認(rèn)的 404/500 響應(yīng)是網(wǎng)頁(yè)，而 API 服務(wù)需要響應(yīng) JSON 數(shù)據(jù)，通常其他傳統(tǒng) MVC 框架需要修改很多地方才可完成這個(gè)需求，MixPHP 本身就提供該種配置，只需修改一下配置即可。

MixPHP 的默認(rèn) HTTP 應(yīng)用中有兩個(gè)配置文件，分別為：

http_permanent.php ：部署在 mix-httpd 的常駐同步模式時(shí)使用。

http_compatible.php ：部署在 Apache/PHP-FPM 時(shí)使用。

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

現(xiàn)在我們修改 response 鍵名下的 defaultFormat 鍵為 mixhttpError::FORMAT_JSON，如下：

// 響應(yīng)
"response" => [
    // 類路徑
    "class"         => "mixhttpcompatibleResponse",
    // 默認(rèn)輸出格式
    "defaultFormat" => mixhttpResponse::FORMAT_JSON,
    // json
    "json"          => [
        // 類路徑
        "class" => "mixhttpJson",
    ],
    // jsonp
    "jsonp"         => [
        // 類路徑
        "class" => "mixhttpJsonp",
        // callback鍵名
        "name"  => "callback",
    ],
    // xml
    "xml"           => [
        // 類路徑
        "class" => "mixhttpXml",
    ],
],

然后修改 main_compatible.php 文件中 error 鍵名下的 format 鍵為 mixhttpError::FORMAT_JSON，如下：

// 錯(cuò)誤
"error"    => [
    // 類路徑
    "class"  => "mixhttpError",
    // 輸出格式
    "format" => mixhttpError::FORMAT_JSON,
],

第三步

創(chuàng)建控制器：

apps/index/controllers/ArticlesController.php

attributes = Request::get();
        $model->setScenario("actionDetails");
        if (!$model->validate()) {
            return ["code" => ErrorCode::INVALID_PARAM];
        }
        // 獲取數(shù)據(jù)
        $data = $model->getDetails();
        if (!$data) {
            return ["code" => ErrorCode::ERROR_ID_UNFOUND];
        }
        // 響應(yīng)
        return ["code" => ErrorCode::SUCCESS, "data" => $data];
    }

}

創(chuàng)建錯(cuò)誤碼類：

apps/index/messages/ErrorCode.php


創(chuàng)建表單驗(yàn)證模型：
apps/index/models/ArticlesForm.php
 ["integer", "unsigned" => true, "maxLength" => 10],
        ];
    }

    // 場(chǎng)景
    public function scenarios()
    {
        return [
            "actionDetails" => ["required" => ["id"]],
        ];
    }

    // 獲取詳情
    public function getDetails()
    {
        return (new ArticlesModel())->getRowById($this->id);
    }

}
創(chuàng)建數(shù)據(jù)表模型：
apps/common/models/ArticlesModel.php
bindParams([
            "id" => $id,
        ])->queryOne();
        return $row;
    }

}
以上就是全部代碼的編寫。
第四步
使用 Postman 測(cè)試，如下：

接口開發(fā)與測(cè)試完成，是不是很簡(jiǎn)單呀。
MixPHP
GitHub: https://github.com/mixstart/m...
官網(wǎng)：http://www.mixphp.cn/