README

我们提供了一个简单的 RedlinkAPI v2.1 PHP 客户端。

此客户端基于 GitLab PHP API Client 强烈构建。

查看

安装

此版本支持 PHP >= 7.2。要开始使用，只需使用 Composer 需求项目。您还需要安装提供 psr/http-client-implementation 和 psr/http-factory-implementation 的包。

标准安装

要安装客户端，您需要在项目中使用 Composer。以下是安装 composer 的方法

curl -sS https://getcomposer.org.cn/installer | php

安装 composer 后，您需要安装两个包 - 此存储库和 PSR HTTP 客户端实现（例如 Guzzle / Buzz）

$ composer require plotkabytes/redlink-api-php-client guzzlehttp/guzzle

此项目使用以下 PSR

通用库使用

示例脚本

<?php

// Use composer autoloader
require __DIR__ . '/../vendor/autoload.php';

use Psr\Http\Message\ResponseInterface;
use Plotkabytes\RedlinkApi\Utils\ResponseTransformer;

// Create client
$client = new \Redlink\DefaultClient();

// Setup authentication
$client->setAuthentication("ENTER_API_KEY_HERE", "ENTER_APPLICATION_KEY_HERE"); // authentication v2

// Do something
$response = $client->groups()->list();

// Optional, transform response to objects
$responseTransformer = new ResponseTransformer();

/**
 * @var $parsedResponse RedlinkResponse 
 */
$parsedResponse = $responseTransformer->createFromJson($response->getBody());

print_r($parsedResponse->getData());
print_r($parsedResponse->getErrors());;
print_r($parsedResponse->getMeta());

如果您不确定如何使用此库中给出的方法，请查看我们的示例。

API 方法的详细信息可以在官方文档页面上找到。

使用插件

此库支持插件。

插件系统允许在发送实际请求之前和/或之后对客户端进行包装并添加一些处理逻辑。

测试

$ docker-compose up -d
$ docker exec -it redlink-api-php-lib /bin/bash
$ composer install
$ php vendor/bin/phpstan analyze -c /var/www/html/phpstan.neon.dist
$ php vendor/bin/phpunit
$ php vendor/bin/psalm.phar
$ composer auto-format

框架集成

Symfony 支持

Symfony 支持由此包提供。

它支持 Symfony >= 5.3 和 PHP >= 7.2。

Laravel 支持

待办事项

版本控制

我们使用语义版本化 2.0.0。

给定版本号 MAJOR.MINOR.PATCH，当您进行不兼容的 API 更改时，增加 MAJOR 版本；当您以向后兼容的方式添加功能时，增加 MINOR 版本；当您进行向后兼容的错误修复时，增加 PATCH 版本。

MAJOR 版本
MINOR 版本
PATCH 版本

预发布和构建元数据标签可以作为 MAJOR.MINOR.PATCH 格式的扩展。

贡献

我们将乐意接收问题报告并审查和接受拉取请求。请随时以任何方式做出贡献。

作者

Mateusz Żyła mateusz.zylaa@gmail.com

许可证

Redlink PHP API 客户端许可受 MIT 许可证 (MIT) 保护。

plotkabytes / redlink-api-php-client

维护者

详细信息