README

这是一个 BaseKit REST API 的 PHP 客户端。此客户端将提供 BaseKit API 可用服务的文档，描述 URI、HTTP 方法和输入参数。

安装

将此包包含到您的项目中的推荐方式是使用 Composer。将其添加到项目 composer.json 文件的 require 部分。

composer require basekit/php-api-client

使用方法

use BaseKit\Api\AuthType;
use BaseKit\Api\ClientFactory;

$client = ClientFactory::create(
    [
        'base_uri' => 'http://api.testing.com',
        'username' => 'foo',
        'password' => 'bar',
    ],
    AuthType::BASIC, // defaults to basic auth
);

$createSite = $client->getCommand(
    'CreateSite',
    [
        'accountHolderRef' => 123,
        'brandRef' => 789,
        'domain' => 'test.example.org',
    ]
);

$client->execute($createSite);

更详细的示例脚本在这里提供，包括账户和站点的创建，以及使用 API 填充站点内容。

测试

将可选的 handler 传递给 clientFactory 的配置中，以控制来自 http 客户端的响应。

use BaseKit\Api\ClientFactory;
use GuzzleHttp\HandlerStack;
use GuzzleHttp\Handler\MockHandler;
use GuzzleHttp\Psr7\Response;

$client = ClientFactory::create([
    'base_uri' => 'https://api.testing.com',
    'username' => 'foo',
    'password' => 'bar',
    'handler' => HandlerStack::create(
        new MockHandler([
            new Response(404, [], '"Hello, World! This is a test response."'),
        ])
    ) ,
]);

$createSite = $client->getCommand(
    'CreateSite',
    [
        'accountHolderRef' => 123,
        'brandRef' => 789,
        'domain' => 'test.example.org',
    ]
);

$client->execute($createSite); // Throws a 404 CommandClientException

许可证

本软件根据 MIT 许可证 发布。