README

• Getting started
  • Prerequisites
  • Installation
  • Usage
• Symfony Bundle
  • Registering the Bundle
  • Configuration
  • Usage
• Repositories
• Contributing
• Credits
• License

Jira API Client is a modern PHP library that provides a simple and fluent interface to interact with the Jira API.

Getting started

Prerequisites

This library requires PHP 8.1 or higher and the following PHP extensions:

• dom
• json
• xml

Installation

Add xen3r0/jira-api-client to your composer.json file:

php composer.phar require xen3r0/jira-api-client

Usage

Create a new instance of the JiraClient class:

use Xen3r0\JiraApiClient\Configuration\ConfigurationFactory;
use Xen3r0\JiraApiClient\Http\JiraClient;

$configuration = ConfigurationFactory::create([
    'host' => 'https://your-jira-instance.atlassian.net',
    'username' => 'your-username',
    'password' => 'your-api-token',
]);
$client = new JiraClient($configuration);

Now, you can use some repositories, for example, IssueRepository:

use Xen3r0\JiraApiClient\Repository\IssueRepository;

$issueRepository = new IssueRepository($client);
$issue = $issueRepository->findByIdOrKey('PROJECT-123');

Symfony Bundle

You can also use this library as a Symfony bundle, you don't need to add another package to your composer dependencies.

Registering the Bundle

To register the bundle, add it to your config/bundles.php file:

return [
    // ...
    Xen3r0\JiraApiClient\Symfony\Bundle\JiraApiClientBundle::class => ['all' => true],
];

Configuration

Then, configure the bundle in your config/packages/jira_api_client.yaml file:

jira_api_client:
    host: 'https://your-jira-instance.atlassian.net'
    username: 'your-username'
    password: 'your-api-token'

Usage

You can now use every repository as a service in your Symfony application. For example, to use the IssueRepository:

use Xen3r0\JiraApiClient\Repository\IssueRepositoryInterface;

#[Route('/some-route', name: 'some_route')]
class SomeController
{
    public function __construct(
        private readonly IssueRepositoryInterface $issueRepository,
    ) {
        $this->issueRepository = $issueRepository;
    }

    public function __invoke(): void
    {
        $issue = $this->issueRepository->findByIdOrKey('PROJECT-123');
        // Do something with the issue...
    }
}

Repositories

This library provides several repositories to interact with different Jira API endpoints. Here are some of the available repositories:

• CustomFieldOptionRepository: Manage custom field options in Jira.
• IssueCommentRepository: Manage comments on issues in Jira.
• IssueRepository: Manage issues in Jira.
• ProjectRepository: Manage projects in Jira.
• VersionRepository: Manage versions in Jira.

A repository is missing ? You can suggest a new repository by opening an issue and/or pull request.

Contributing

See the CONTRIBUTING.md file for details on how to contribute to this project.

Credits

• Manuel Santisteban

License

This project is licensed under the MIT License - see the LICENSE file for details