Skip to content

nulab/backlog4j

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Backlog4j Build Status

Backlog4j is a Backlog binding library for Java. (英語の下に日本文が記載されています)

Updates

  • 2022/09/15 2.5.2 released
  • 2022/08/24 2.5.1 released
  • 2022/04/27 2.5.0 released
  • 2021/06/10 2.4.4 released
  • 2021/04/23 2.4.3 released

https://github.com/nulab/backlog4j/releases

How to Install

gradle

'com.nulab-inc:backlog4j:2.5.2'

maven

<dependency>
  <groupId>com.nulab-inc</groupId>
  <artifactId>backlog4j</artifactId>
  <version>2.5.2</version>
</dependency>

How to use

Make BacklogConfigure with your space id and your api key.

# If your space is in backlog.com
BacklogConfigure configure = new BacklogComConfigure("yourSpaceId").apiKey("yourApiKey");

# If your space is in backlogtool.com
BacklogConfigure configure = new BacklogToolConfigure("yourSpaceId").apiKey("yourApiKey");

# If your space is in backlog.jp
BacklogConfigure configure = new BacklogJpConfigure("yourSpaceId").apiKey("yourApiKey");

And get the BacklogClient.

BacklogClient backlog = new BacklogClientFactory(configure).newClient();

Then call Backlog API method. Enjoy Backlog API!

Project project = backlog.getProject("PROJECT-KEY");

Documents

License

MIT License

Requires

  • Java 1.8

Backlog4j とは

Backlog4j は Backlog API (https://developer.nulab.com/ja/docs/backlog/#) に簡単にアクセスするためのJavaクライアントライブラリです。

インストール

gradle を利用する場合

'com.nulab-inc:backlog4j:2.5.2'

maven を利用する場合

<dependency>
  <groupId>com.nulab-inc</groupId>
  <artifactId>backlog4j</artifactId>
  <version>2.5.2</version>
</dependency>

使い方

基本的な使い方は以下の 2 ステップとなります。

  • BacklogConfigure を設定して BacklogClient オブジェクトを生成
  • Backlog API に従ったメソッド呼び出し

以下の例では スペースIDとAPIキーを用いて BacklogConfigure を設定しています。

# あなたのスペースが backlog.com 内にある場合
BacklogConfigure configure = new BacklogComConfigure("yourSpaceId").apiKey("yourApiKey");

# あなたのスペースが backlog.jp 内にある場合
BacklogConfigure configure = new BacklogJpConfigure("yourSpaceId").apiKey("yourApiKey");

# あなたのスペースが backlogtool.com 内にある場合
BacklogConfigure configure = new BacklogToolConfigure("yourSpaceId").apiKey("yourApiKey");

続いて BacklogClient を生成します。

BacklogClient backlog = new BacklogClientFactory(configure).newClient();

そして、取得したいプロジェクトのキーを指定し、プロジェクト情報をAPI経由で取得します。

Project project = backlog.getProject("PROJECT-KEY");

Android でご使用の場合

proguard-rules に以下を追記して難読化の対象外とすることを推奨します。

#Backlog4j
-keep public class com.nulabinc.backlog4j.** {*;}

#Jackson(Backlog4j is using jackson)
-keepattributes *Annotation*,EnclosingMethod, Signature, InnerClasses
-keepnames class com.fasterxml.jackson.** { *; }
-dontwarn com.fasterxml.jackson.databind.**

About

Java library for Backlog API version 2

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages