kain/emqx-management-api

EMQX Management HTTP API

4.3.0 2021-04-24 12:18 UTC

Requires

• php: >=7.4
• ext-json: *
• guzzlehttp/guzzle: ^6.2 || ^7.0
• php-di/php-di: ^6.0

Requires (Dev)

• php-coveralls/php-coveralls: ^2.0
• phpunit/php-code-coverage: ^8.0
• phpunit/phpunit: ^9.0
• roave/security-advisories: dev-master

MIT

• kain

README

EMQ X 管理组件资源开放接口 PHP 的实现版

安装

composer require kain/emqx-management-api

快速开始

创建客户端

$emqx = \EMQX\API\EMQXClient::create(
    'http://localhost:8081/api/v4/',
    '<your appid>',
    '<your appsecret>'
);

$response = $emqx->endpoints();
if ($response->isError()) {
    echo $response->getMsg();
    return;
}

var_dump($response->result());

或者自定义 \GuzzleHttp\Client

$client = new \GuzzleHttp\Client([
    'base_uri' => 'http://localhost:8081/api/v4/',
    'auth' => ['<your appid>', '<your appsecret>'],
    'timeout' => 30.0,
    'debug' => false,
    'verify' => false,
    'version' => 1.1
]);

$emqx = new \EMQX\API\EMQXClient($client);

$response = $emqx->endpoints();
if ($response->isError()) {
    echo $response->getMsg();
    return;
}

var_dump($response->result());

发布消息

$option = new \EMQX\API\Common\MqttPublishOption(
    ['notification'],
    'hello'
);
$option->setEncoding('plain');
$option->setQos(0);
$option->setRetain(false);
$response = $emqx->mqtt()->publish($option);

if ($response->isError()) {
    echo $response->getMsg();
    return;
}
var_dump($response->result());

SDK 遵循官网文档开发，https://docs.emqx.cn/broker/latest/advanced/http-api.html

重大变更

• 从4.3.0 版本开始 Response 不再使用 getData() 并替换为 getBody() 返回接口默认响应体