README

简介

PHP 编写的 cydrobolt/polr REST API 客户端

提供与 Polr 实例交互的简单接口

用法

一个非常简单的示例，使用默认配置

<?php

namespace NorthernLights\Client\Polr\Example;

use NorthernLights\Client\Polr\ApiClient;
use NorthernLights\Client\Polr\Config\Config;
use NorthernLights\Client\Polr\Response\ShortenResponseInterface;


/**
 * Initialize API client and pass $config to it (DI)
 * @var ApiClient $api
 */
$api = new ApiClient();

/**
 * Shorten the long URL.
 * @var ShortenResponseInterface $response
 */
$response = $api->shorten('https://www.polrproject.org');

// Check if API request was successful. Remains true as long as HTTP status code equals 200 OK
if (!$response->wasSuccessful()) {
    echo 'There was an error querying the api' . PHP_EOL;
    exit(1);
}

echo 'Short URL is ' . $response->getShortUrl() . PHP_EOL;

有关更详细示例和配置，请参阅示例。所有使用场景都涵盖在内。

安装

建议通过 Composer 安装

composer require northern-lights/polr-client

或者，您可以从中下载最新稳定版本发布。

请注意，此库不附带自动加载器，但依赖于 Composer 内置的自动加载器。

行业标准与最佳实践

库努力遵守行业中的最新标准和最佳实践，因此我们包含了以下内容

PSR-2 编码标准合规性检查 & 修复

我们希望代码尽可能好

squizlabs/PHP_CodeSniffer

$ composer check-style
$ composer fix-style

注意：第二个命令实际上会修改文件

代码语法检查（lint）

非常基本的检查，可以节省我们很多麻烦

jakub-onderka/php-parallel-lint

$ composer php-lint

静态代码分析

这样我们可以尽早捕捉到错误。

phpstan/phpstan

$ composer phpsam

单元测试

这样我们可以确保所有部件都在顺利运行

phpunit/phpunit

$ composer test

待办事项

实现批量缩短 [/api/v2/action/shorten_bulk]
添加单元测试
添加详细的 API 文档

免责声明

本项目或其作者与 Polr 项目或任何第三方无关。

许可证

MIT 许可证 (MIT)。有关更多信息，请参阅许可证文件。

northern-lights / polr-client

维护者

详细信息

README

简介

用法

安装

行业标准与最佳实践

待办事项

免责声明

许可证