dev-master 2022-11-30 07:14 UTC

This package is auto-updated.

Last update: 2024-09-29 06:03:26 UTC


README

构建

生成的代码对外部库(如UniRest和JsonMapper)有依赖。JsonMapper需要docblock注释(如@var@maps@factory)来将JSON响应映射到我们的类定义。因此,即使禁用了PHP配置(如opcache.save_comments),也无法禁用生成的代码中的docblock。这些依赖在SDK提供的composer.json文件中定义。要解决这些依赖,我们使用Composer包管理器,它需要系统上安装了PHP 7.2或更高版本。请访问https://getcomposer.org/download/下载Composer安装程序文件,并在系统上运行它。打开命令提示符并输入composer --version。如果安装成功,它应显示已安装的Composer的当前版本。

  • 使用命令行,导航到包含生成的文件(包括composer.json)的SDK目录。
  • 运行命令composer install。这将安装所有必需的依赖,并在您的项目目录中创建vendor目录。

Building SDK - Step 1

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

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

CURL曾经包含一组接受的CA列表,但现在不再捆绑任何CA证书。因此,默认情况下,它将拒绝所有SSL证书作为不可验证的。您将需要获取您的CA证书,并将curl指向它。步骤如下

  1. https://curl.haxx.se/docs/caextract.html将证书捆绑包(.pem文件)下载到您的系统。
  2. 将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

安装

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

1. 在IDE中打开项目

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

Open project in PHPStorm - Step 1

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

Open project in PHPStorm - Step 2

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

如下所示,在解决方案名称上右键单击以创建新目录

Add a new project in PHPStorm - Step 1

将目录命名为"test"。

Add a new project in PHPStorm - Step 2

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

Add a new project in PHPStorm - Step 3

将其命名为"testSDK"。

Add a new project in PHPStorm - Step 4

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

require_once "vendor/autoload.php";

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

Add a new project in PHPStorm - Step 5

之后,您可以添加代码来初始化客户端库并获取Controller类的实例。后续部分给出了初始化客户端库和使用Controller方法的示例代码。

3. 运行测试项目

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

文件菜单中打开设置

Run Test Project - Step 1

语言和框架中,选择PHP

Run Test Project - Step 2

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

Run Test Project - Step 3

选择解释器后,点击确定

Run Test Project - Step 4

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

Run Test Project - Step 5

测试SDK

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

  1. 首先使用composer安装依赖,包括require-dev依赖项。
  2. 从命令行运行vendor\bin\phpunit --verbose以执行测试。如果您已全局安装PHPUnit,请使用phpunit --verbose运行测试。

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

初始化API客户端

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

以下参数可配置API客户端

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

$client = FortisAPILib\FortisAPIClientBuilder::init()
    ->userId('user-id')
    ->userApiKey('user-api-key')
    ->developerId('developer-id')
    ->environment('sandbox')
    ->build();

环境

SDK可以配置为使用不同的环境进行API调用。可用的环境有

字段

授权

此API使用自定义头部签名

API列表

类文档