README

介绍

描述

构建

生成的代码依赖于外部库，如UniRest。这些依赖在SDK附带的composer.json文件中定义。要解决这些依赖，我们使用Composer包管理器，它需要在您的系统上安装PHP 7.2或更高版本。访问https://getcomposer.org/download/下载Composer安装程序文件，并在您的系统上运行它。打开命令提示符并输入composer --version。如果安装成功，这将显示已安装的Composer的当前版本。

使用命令行，导航到包含生成的文件（包括composer.json）的SDK目录。
运行命令composer install。这将安装所有必要的依赖关系，并在您的项目目录中创建vendor目录。

在php.ini中配置CURL证书路径

ℹ️ 注意这仅适用于Windows用户。

CURL曾经包含一组受信任的CA列表，但现在不再捆绑任何CA证书。因此，默认情况下，它将拒绝所有SSL证书，因为它们无法验证。您必须获取您的CA证书，并将curl指向它。步骤如下：

从https://curl.haxx.se/docs/caextract.html下载证书捆绑包（.pem文件）到您的系统。
将curl.cainfo = "PATH_TO/cacert.pem"添加到您的php.ini文件中，该文件位于您的PHP安装目录。 “PATH_TO”必须是一个包含.pem文件的绝对路径。

[curl]; A default value for the CURLOPT_CAINFO option. This is required to be an
; absolute path.
curl.cainfo = PATH_TO/cacert.pem

安装

以下部分解释了如何在新的项目中使用PQAPIV2Lib库。

1. 在IDE中打开项目

打开PHP的IDE，如PhpStorm。这里展示的基本工作流程也适用于您如果更喜欢使用不同的编辑器或IDE。

在PhpStorm中点击打开，浏览到生成的SDK目录，然后点击确定。

2. 添加一个新的测试项目

如以下所示，在解决方案名称上右键单击以创建一个新的目录。

将目录命名为"test"。

向此项目添加一个PHP文件。

将其命名为"testSDK"。

根据您的项目设置，您可能需要在PHP代码中包含composer的自动加载器，以启用类的自动加载。

require_once "vendor/autoload.php";

确保require_once路径正确指向依赖安装期间在vendor目录中创建的autoload.php文件。

之后，您可以添加代码来初始化客户端库并获取控制器类的实例。后续部分提供了初始化客户端库和使用控制器方法的示例代码。

3. 运行测试项目

要运行您的项目，您必须设置项目的解释器。解释器是安装在您计算机上的PHP引擎。

从文件菜单中打开设置。

从语言与框架中选择PHP。

在解释器选项附近浏览解释器，并选择您的解释器。

选择解释器后，点击确定。

要运行您的项目，在测试项目中的PHP文件上右键单击，然后点击运行。

测试SDK

可以使用PHPUnit运行此SDK中的单元测试。

首先使用composer安装依赖，包括require-dev依赖。
从命令行运行 vendor\bin\phpunit --verbose 来执行测试。如果您已全局安装PHPUnit，则使用 phpunit --verbose 来运行测试。

您可以在 phpunit.xml 文件中更改PHPUnit测试配置。

初始化API客户端

注意：客户端的文档可以在这里找到。链接

以下参数可以配置API客户端

API客户端可以按以下方式初始化

$client = new PQAPIV2Lib\PQAPIV2Client([
    // Set the environment
    'environment' => 'production',
]);

obaidkhattak / pqapiv2

维护者

详细信息