Giter Club home page Giter Club logo

youtrack4j's Introduction

YouTrack4J

This is an unofficial YouTrack client for Java Language.


Configuration

This client requires 2 properties.

property key property value
youtrack.access.token Access Token for YouTrack.
youtrack.base.url Base URL for your YouTrack instance, with finishing with path /youtrack.

These properties can be given via JVM parameters(java -jar your.jar -Dyoutrack.access.token=xxxx), a file with name youtrack.properties at working directory or a resource file(the name is youtrack.properties too).

The order of file to be loaded is determined as follows.

  1. JVM parameters.
  2. youtrack.properties file on a working directory.
  3. youtrack-test.properties file on classpath resource.
  4. youtrack.properties file on classpath resource.

Usages

This client currently supports these APIs.

  • getAccessibleProjects
  • createNewIssue

getAccessibleProjects

Requests GET /projects/all and returns List<YouTrackProject>.

public class Sample {
  public static void main(String[] args){
    try (final YouTrack youTrack = YouTrack.getInstance()) {
      youTrack.getAccessibleProjects()
        .executeRequest()
        .onSuccess(projects -> projects.forEach(System.out::println))
        .block();
    }
  }
}
// -> ShortYouTrackProject{name='Project Name', shortName='PN'}

createNewIssue

Requests POST /issue and returns Issue

public class Sample {
  public static void main(String[] args) {
    try (final YouTrack youTrack = YouTrack.getInstance()) {
      youTrack.createNewIssueInProject("PN")
        .summary("The style of UserName in front page is broken.")
        .executeRequest()
        .map(Issue::getId)
        .onSuccess(System.out::println)
        .block();
    }
  }
}
// -> IssueId[id: PN-123065]

youtrack4j's People

Contributors

mike-neck avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.