lebato / snowflake-sdk-php
此API用于生成通用唯一标识号。
Requires
- php: >=5.4.0
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- apimatic/jsonmapper: ~1.3.0
- mashape/unirest-php: ~3.0.1
Requires (Dev)
- phpunit/phpunit: 4.8.*
- squizlabs/php_codesniffer: ^2.7
This package is not auto-updated.
Last update: 2024-09-22 03:57:41 UTC
README
此API用于生成通用唯一标识号。
如何构建
生成的代码依赖于外部库,如UniRest。这些依赖关系定义在SDK附带的composer.json
文件中。为了解决这些依赖关系,我们使用Composer包管理器,它需要您的系统上安装了大于5.3.2的PHP。访问https://getcomposer.org/download/下载Composer安装文件,并在您的系统上运行它。打开命令提示符并输入composer --version
。如果安装成功,应显示已安装的Composer当前版本。
- 使用命令行,导航到包含生成的文件(包括
composer.json
)的SDK目录。 - 运行命令
composer install
。这将安装所有必需的依赖关系,并在您的项目目录中创建vendor
目录。
[仅限Windows用户] 在php.ini中配置CURL证书路径
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 =
如何使用
以下部分解释了如何在新的项目中使用SnowflakeAPI库。
1. 在IDE中打开项目
打开PHP如PhpStorm的IDE。这里介绍的基本工作流程也适用于您更喜欢使用不同的编辑器或IDE的情况。
在PhpStorm中点击打开
,浏览到您的生成的SDK目录,然后点击确定
。
2. 添加一个新的测试项目
如下所示,在解决方案名称上右键单击创建新目录
将目录命名为"test"
向此项目添加一个PHP文件
命名为"testSDK"
根据您的项目设置,您可能需要在PHP代码中包含composer的自动加载器以启用类的自动加载。
require_once "../vendor/autoload.php";
确保require_once中的路径正确指向在依赖安装期间创建的vendor目录中的autoload.php
文件。
之后,您可以添加初始化客户端库并获取控制器类实例的代码。后续部分提供了初始化客户端库和使用控制器方法的示例代码。
3. 运行测试项目
要运行您的项目,您必须为项目设置解释器。解释器是安装在您的计算机上的PHP引擎。
从文件
菜单中打开设置
。
从语言与框架
中选中PHP
。
在解释器
选项附近浏览解释器并选择您的解释器。
选择解释器后,点击确定
。
要运行您的项目,在测试项目中的PHP文件上右键单击,然后点击运行
。
如何测试
可以使用PHPUnit运行此SDK中的单元测试。
- 首先使用composer安装依赖关系,包括
require-dev
依赖关系。 - 在命令行中运行
vendor\bin\phpunit --verbose
来执行测试。如果您已全局安装PHPUnit,则使用phpunit --verbose
运行测试。
您可以在 phpunit.xml
文件中更改PHPUnit测试配置。
初始化
API客户端可以按以下方式初始化。
$client = new SnowflakeAPILib\SnowflakeAPIClient();
类参考
控制器列表
APIController
获取单例实例
可以从API客户端访问APIController
类的单例实例。
$client = $client->getClient();
getIdGet
标签:
跳过认证
基于Twitter的Snowflake算法。
function getIdGet()
示例用法
$result = $client->getIdGet();