README

此组件可以帮助您创建一个由Neosolva支持的API的客户端。

身份验证基于基本HTTP身份验证。用户名和API密钥由您的销售合作伙伴提供。

安装

打开命令行，进入您的项目目录，并执行以下命令以下载此包的最新稳定版本

$ composer require neosolva/php-api-client

此命令要求您全局安装了Composer，如Composer文档中的安装章节中所述。

使用方法

类Neosolva\Component\Api\Client扩展了类GuzzleHttp\Client。静态方法create()可以帮助您配置客户端。

请参阅Guzzle客户端文档以了解如何使用客户端。

创建客户端

require_once 'vendor/autoload.php';

use Neosolva\Component\Api\Client; # extends GuzzleHttp\Client

$client = Client::create('https://...', 'username', 'password');

发送请求

# 
# GET operation
#

$response = $client->get('/foo');

# 
# POST operation
#

$data = [
    'foo' => 'bar',
    'baz' => 'qux'
];

$response = $client->post('/bar', [
    'json' => $data
]);

响应是接口Psr\Http\Message\ResponseInterface的实例。

解码JSON响应

所有由Neosolva支持的API都以JSON格式返回内容。客户端提供decode()方法从响应中获取解码数据。

$data = $client->decode($response, false); # array|bool|float|int|object|string|null
$data = $client->decode($response, true); # array

要获取数组形式的关联结果，请使用快捷方法decodeData()

$data = $client->decodeData($response); # array

其他

检索基本URI

客户端提供了一个快捷方式来检索配置的基本URI。

$baseUri = $client->getBaseUri(); # string

更新日志

v1.0.2

添加了方法Client::decodeData()

v1.0.1

将Guzzle包版本从"guzzlehttp/guzzle": "^7.0"更新到"guzzlehttp/guzzle": "^6.0 || ^7.0"

neosolva/ php-api-client

维护者

详细信息