README

与 JIRA API 交互的 PHP 客户端。

随着我们需要功能，我们慢慢构建这个客户端。最初，我们只需要用于管理用户账户。

此客户端基于 Guzzle 构建，即 PHP HTTP 客户端。Guzzle 提供了一种简单的方式来创建 API 客户端，通过使用类似于 Swagger 的格式描述 API，无需自行实现每个方法。因此，添加更多 JIRA API 的支持相对简单。如果您想提交一个 pull 请求以添加另一个功能，请这样做。如果您不知道如何操作，请向我们询问，我们可能会为您添加。

JIRA API 身份验证

JIRA 使用基本身份验证来验证 API 调用。您必须通过参数 apiuser 和 apipass 提供您的 API 用户的用户名和密码。

安装

使用 Composer 进行安装很简单。将 "silinternational/jira-php-client": "dev-master" 添加到您的 composer.json 文件中，并更新。

使用方法

示例

<?php

use JIRA\Client;

$client = new Client([
  'apiuser' => 'username',
  'apipass' => 'password',
]);

$user = $client->getUser(['userId' => 123456789]);

echo $user['email'];
// example@domain.org

$newUser = $client->addUser([
  "name" => "test_user",
  "password" => "newpassword",
  "emailAddress" => "test_user@domain.org",
  "displayName" => "test user",
]);

echo $user['data']['userId'];
// 1234567890

如果您托管自己的 JIRA 企业服务器，您可以覆盖默认的 API URL

<?php

use JIRA\Client;

$client = new Client([
  'apiuser' => 'username',
  'apipass' => 'password',
  'description_override' => [
    'baseUrl' => 'https://my.server.com',
  ],
]);

Guzzle 服务客户端说明

由 Jeremy Lindblom 演示：https://speakerdeck.com/jeremeamia/building-web-service-clients-with-guzzle-1
由 Jeremy Lindblom 提供的示例：https://github.com/jeremeamia/sunshinephp-guzzle-examples
源代码注释中的参数文档：https://github.com/guzzle/guzzle-services/blob/master/src/Parameter.php

silinternational / jira-php-client

维护者

详细信息

README

JIRA API 身份验证

安装

使用方法

Guzzle 服务客户端说明