comfortable/php-sdk

为 comfortable.io 提供的 PHP SDK

维护者

详细信息

github.com/cmftable/php-sdk

源代码

问题

安装: 454

依赖: 0

建议: 0

安全性: 0

星标: 2

关注者: 3

分支: 0

开放问题: 0

3.3.0 2024-04-11 13:05 UTC

Requires

Requires (Dev)

MIT dde317834849233c483ef2b678917a112ba5ccaf

  • Christian Schwerdt <christian.woop@cmft.io>

This package is not auto-updated.

Last update: 2024-09-26 15:48:09 UTC

README




PHP 开发工具包

Build Status

安装

Comfortable PHP SDK 可以通过 Composer 安装。运行以下命令：

composer require comfortable/php-sdk

用法

注意：此版本的 SDK 需要 PHP 5.6 或更高版本。


包含依赖项

<?php
require_once __DIR__ . '/vendor/autoload.php'; // change path as needed

use Comfortable;

连接到您的仓库并发出第一个请求

$api = Comfortable\Api::connect('{repository-api-id}', '{api-key}');

try {
  // get all documents stored in comfortable (default limit: 25)
  $results = $api->getDocuments()->execute();
} catch (\RuntimeException $e) {
  echo 'Comfortalbe SDK returned an error: ' . $e->getMessage();
  exit;
}

完整文档、安装说明和示例可在此处找到：此处。

测试

  1. 运行测试需要 Composer。全局安装 composer，然后运行 composer install 以安装所需文件。
  2. 从 phpunit.xml.dist 创建 phpunit.xml 并编辑它以添加您的凭据。或者，您可以将凭据作为环境变量设置。为此，您需要定义 CMFT_REPOSITORY 和 CMFT_APIKEY。
  3. 可以从根目录运行以下命令来执行测试
./vendor/bin/phpunit

更多信息

贡献

欢迎提交拉取请求！

PRs Welcome

许可

此仓库在 MIT 许可下发布。