invisible-collector/shlink-php-client

shlink 的 PHP HTTP+JSON 客户端

v0.1 2020-01-10 16:53 UTC

README

shlink的 HTTP+JSON 客户端。

composer 上检查此包。

要安装此库,请运行

composer require invisible-collector/shlink-php-client:dev-master

说明

开发

此存储库使用 PSR-2 风格指南。

设置

安装依赖项

sudo apt-get install php7.2-{xml,mbstring,json} 
composer install

代码检查器

运行代码检查器

php -l . # will check
./vendor/bin/phpcs  --standard=PSR2 src

自动修复代码检查问题

./vendor/bin/phpcbf  --standard=PSR2 src

文档

设置

composer global require jms/serializer:1.7.*
composer global require phpdocumentor/phpdocumentor:^2.9

生成文档

~/.config/composer/vendor/bin/phpdoc -d ./src -t ./docs

测试

运行测试

docker-compose up

# in another window
SHLINK_HOST=localhost:8080 SHLINK_API_KEY=$(cat ci/api_key.txt) ./vendor/bin/phpunit --bootstrap vendor/autoload.php tests

示例

查看示例 文件夹 以了解如何使用客户端。

注意事项

查看 ci docker 图像 说明