https://github.com/oveleon/youtrack-api-php
YouTrack REST API library for PHP.
https://github.com/oveleon/youtrack-api-php
api php youtrack
Last synced: 6 months ago
JSON representation
YouTrack REST API library for PHP.
- Host: GitHub
- URL: https://github.com/oveleon/youtrack-api-php
- Owner: oveleon
- Created: 2023-01-12T09:15:27.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-21T15:10:53.000Z (11 months ago)
- Last Synced: 2025-03-23T21:17:14.143Z (7 months ago)
- Topics: api, php, youtrack
- Language: PHP
- Homepage: https://oveleon.github.io/youtrack-api-php/
- Size: 42 KB
- Stars: 3
- Watchers: 3
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# YouTrack API for PHP
This bundle is a PHP wrapper for the YouTrack REST API. It allows communication with your YouTrack instance.
## Installation
```
$ composer require oveleon/youtrack-api-php
```
## Getting Started
```PHP
use Oveleon\YouTrack\Client;
use Oveleon\YouTrack\HttpClient\HttpClient;
// Create http client to use.
// You can write your own adapter and use the HttpClientInterface to use e.g. the Guzzle HttpClient.
// By default, the HttpClient of Symfony is used.
$httpClient = new HttpClient('https://example.myjetbrains.com', 'perm:your-token');
// Create api client
$api = new Client($httpClient);
// Get issues
$issues = $api->issues()
->all();
// Refine the query using the filter method
$issues = $api->issues()
->filter('state:resolved')
->all();
// Cool, but now we would like to specify the return fields...
$issues = $api->issues()
->fields(['summary', 'description'])
->filter('state:resolved')
->all();
// The query on a specific Project can also be refined in exactly the same way
$issues = $api->issues()
->filter('state:unresolved')
->project('PROJECT_ID');
// The predefined query `findByProject` does nothing more than define a filter for you (In YouTrack the
// filter is described as `query`), so you could also define the following filter to get the same result
$issues = $api->issues()
->filter('project:SampleProject')
->all();
// Use pagination...
$issues = $api->issues()
->paginate(0, 10)
->all();
// And now we use another endpoint
$projects = $api->projects()
->all();
// ...
```
## Documentation
Read the full Documentation.
## References
- YouTrack REST API [Documentation](https://www.jetbrains.com/help/youtrack/devportal/youtrack-rest-api.html)
- Use [Parsedown](https://github.com/erusev/parsedown) or other Markdown parsers to convert descriptions of issues and the like into HTML.
- A simple [ticket system](#) based on this API for the open source CMS Contao
## Contributing
The API currently supports only a subset of the available options. The basic structure has been prepared so that contributing and adding new endpoints is easy. The structure should be self-explanatory, but feel free to [open an issue](https://github.com/oveleon/youtrack-api-php/issues/new) if you have any questions or comments. Supplementary queries or new entry points must be provided as [pull requests](https://github.com/oveleon/youtrack-api-php/pulls).
## ToDo:
- [ ] Provide more endpoints
- [ ] Extend existing endpoints (e.g. create Issue)
- [ ] Documentation