simon-wessel/teamcity-api

此包已被弃用且不再维护。未建议替代包。
此包的最新版本(1.0.0)没有可用的许可信息。

PHP TeamCity API 包装器 - 可与或无 Laravel 5 一起使用

1.0.0 2017-09-14 10:04 UTC

This package is not auto-updated.

Last update: 2021-11-17 06:38:13 UTC


README

Latest Stable Version Total Downloads Monthly Downloads License Latest Unstable Version

一个简单的 PHP 包装器,用于您的 TeamCity 实例的 API,可能用作也可能不作为 Laravel 包。

由于端点数量众多,此包缺少 TeamCity 提供的大部分 API 功能。如果您需要任何缺少的功能,只需将其添加到 API 类中,然后创建一个 pull 请求。

目录

安装

通过运行以下命令可以使用 composer 安装此包

composer require simon-wessel/teamcity-api

独立使用

$url = "https://yoururltoteamcity.com/";
$username = "myusername";
$password = "mypassword";

$teamCityApi = new SimonWessel\TeamCityApi\TeamCityApi($url, $username, $password);

$builds = $teamCityApi->getBuilds();

与 Laravel 一起使用

1. 设置

此包支持 Laravel 5.5 中引入的包自动发现。如果您使用的是 5.5 或更高版本,则可以跳过此步骤。

否则,您必须将 Service Provider 添加到您的 config/app.php 文件中的 providers 数组中

SimonWessel\TeamcityApi\ServiceProvider::class,

如果您想使用 Facade,则必须将其添加到同一文件中的 aliases 数组中

'TeamCity' => \SimonWessel\TeamCityApi\Facade::class,

2. 配置

您需要配置一个 TeamCity 用户账户,拥有您想要访问的数据和操作的所有权限。您可以在您的 .env 文件中设置以下环境变量

TEAMCITY_URL=https://yoururltoteamcity.com/
TEAMCITY_USERNAME=myusername
TEAMCITY_PASSWORD=mypassword

或者,您可以发布包的配置文件并调整其中的设置。要这样做,请运行以下命令

php artisan vendor:publish --provider="SimonWessel\TeamCityApi\ServiceProvider"

您将获得一个新的配置文件 config/teamcity.php,其中包含所有可用设置。

3. 使用

您可以使用 Facade 访问 API

TeamCity::getBuilds()

或直接调用 Service Provider 单例

app('teamcity')->getBuilds()