liveintent / sdk-php
LiveIntent SDK PHP
v0.4.1
2023-07-27 20:41 UTC
Requires
- php: ^8.0|^8.1
- guzzlehttp/guzzle: ^7.3
- illuminate/collections: ^9.2
- illuminate/contracts: ^9.2
- illuminate/http: ^9.2
- illuminate/support: ^9.2
- nesbot/carbon: ^2.46
Requires (Dev)
- liveintent/php-cs-fixer: ^3.0
- nunomaduro/collision: ^6.2
- phpunit/phpunit: ^9.5
- ramsey/conventional-commits: ^1.1
- symfony/finder: ^6.0
- symfony/var-dumper: ^6.0
- vimeo/psalm: ^4.7
- vlucas/phpdotenv: ^5.3
README
LiveIntent PHP SDK 为 PHP 应用程序提供了一种方便的方式与 LiveIntent API 进行交互。
本文件描述了如何开发 SDK 本身。有关使用文档和示例,请参阅 使用说明。
入门
首先克隆存储库。然后,运行 cp .env.example .env
创建 env 文件。
最后,通过以下方式安装依赖项
composer install
测试
要运行单元测试
composer test
模拟
在测试过程中,您通常想要模拟外部 API 调用,但同时也希望确信这些 API 调用在实际世界中也能工作。
为了解决这个问题,您可以指示客户端记录它所发出的请求/响应对。这允许您在需要时针对实时 API 版本运行测试,并在模拟可接受时重用相同的响应,以实现更快、更可预测和更可靠的测试。
记录模式测试
要针对实时 API 连接运行测试并记录结果,请运行
composer test-record
默认情况下,记录将保存在文件 tests/__snapshots__/snapshot
中。
使用记录的响应进行测试
要针对实时 API 连接运行测试并记录结果,请运行
composer test
其他模拟方法
LiveIntent 客户端继承自 Laravel 的 Http Client。因此,该客户端的所有方法也都可用。
有关详细文档,请参阅 此处。
代码风格检查
安装的代码风格检查器将自动格式化您的代码,以符合我们商定的 PHP 编码标准。
要运行代码风格检查器
composer lint