Run the tests with: $ composer test Security Please see CHANGELOG for more information on what has changed recently. Once composer is installed, execute the following command in your project root to install this library: $ composer require cybercog/youtrack-rest-php Without frameworkīe sure to include the autoloader in your project: require_once '/path/to/your-project/vendor/autoload.php' Usage Installation instructions if you do not already have Haven't found your favorite framework in the list? We are open for Pull Requests! Installation
Multiple authorization strategies: Token, Cookie.Using contracts to keep high customization capabilities.I can assure you that you’ll be impressed.YouTrack REST API PHP Client uses PSR-7 (HTTP Message Interface) to connect with JetBrains YouTrack REST API. We can completely automate the process of handling new submissions, such as automatically assigning an defect to a person based on the type of issue, create notifications, send emails (because we all need more emails in our lives) and a whole slew of other actions that can be performed with custom workflows.Īnd of course, having the ability to perform pretty much any type of operation with YouTrack, via the API provides us with the power to create custom user interfaces for different departments or users of our organization, removing unnecessary noise where it makes sense, and providing more information for only those that need it. If we combine the ability to provide a custom user interface for submitting new issues, with the potential that the Workflow Editor provides us, the possibilities are endless. You can try it live here and explore the source code, experiment and adapt it to your own needs. All it is doing is providing a new look and feel for static data generated from YouTrack. What’s awesome about this UI, is that it’s nothing more than a façade over our own instance of YouTrack. It’s an alternative interface written by Alexey Pegov, as a proof of concept, to demonstrate the full potential of the API. Recognize the screen below? Of course you don’t. In fact, we can create a completely new User Interface for listing or displaying issues. Submitting issues isn’t the only thing that can be done using the YouTrack API. Obviously in this case, we have permissions enabled to let anyone submit issues but that can also be restricted by requiring a valid login beforehand. We can now easily embed a form to create issues in any web site. For this example, we’re going to allow access from all sites, although we can limit it to specific domains For that, when logging in as Administrator in YouTrack, under the Adminsitration, REST API, we can specify whether we want external sites to have access to the API ( CORS). To get this to work, we need to enable external access to the API. Enable REST API and Access from external sites. Only remaining thing would be to load the projects on page load:Īlthough for this example we’re using JavaScript, if you prefer to use some other language such as C#, Ruby, Python, know that there are already libraries available. The second function, createIssue which actually creates the issue would be: One obtains a list of projects from our YouTrack server, and the other creates a new issue. The only interesting thing on the page is two JavaScript functions. We’re using Twitter Bootstrap to give it somewhat of a nice design (which coincides now with 90% of the Internet). The page itself is straightforward, being just a form with three elements. Enable the REST API and Access from external sites.Embedding a submit issue form on your web site All this is made possible because of the powerful HTTP API it has. And not only that, but you can actually replace the entire UI of YouTrack. In fact, YouTrack is flexible enough that not only can you limit to very few the number of fields required (namely three), but you can also easily create your own user interface to submit defects.
The answer is of course, no, it’s not complicated at all. Need being of course, that many QA departments don’t want to spend too much time filling out field after field of information to submit a bug. Customers often ask us whether submitting issues in YouTrack is complicated, in the sense that if it requires many fields to be filled in.
0 kommentar(er)
