samihsoylu/youtrack-api-php

YouTrack RestAPI library for PHP

v1.1.0 2021-06-13 16:39 UTC

Requires

• php: ^8.0
• ext-json: *
• guzzlehttp/guzzle: ^7.2

Requires (Dev)

• friendsofphp/php-cs-fixer: ^2.16
• php-parallel-lint/php-parallel-lint: dev-master
• roave/security-advisories: dev-master

Apache-2.0

• Samih Soylu

README

This is an implementation for communicating with the JetBrains YouTrack RestAPI. This library covers basic resource calls available in the YouTrack RestAPI docs. Using this library, you can create, update, delete issues in your YouTrack instance.

Feature highlights

• Query YouTrack for information about projects, and issues.
• Create, update and delete issues.
• Add time spent to issues.

Requirements

The YouTrack Rest API library requires the following in order to work properly:

• PHP 8.0.0 or later.
• curl (php extension)
• json (php extension)
• openssl (php extension)

Installation

composer require samihsoylu/youtrack-api-php

How to use?

Please look inside the examples/ directory for more information on how to use the api client.

This library has been tested in a YouTrack instance that has the following fields: Priority, Type, Assignee, State, and Estimation. These field names must exist in your YouTrack project for this library to work out of the box.

Disclaimer

YouTrack is a very customizable issue tracking system. This library will likely not function if you have customized your fields in your YouTrack instance. In order to make use of this library, you may have to fork this project and make adjustments to the Repository classes accordingly.