/var/www/yatta47.log

やったのログ置場です。スクラップみたいな短編が多いかと。

Backlog APIをRubyで操作する(準備編)

Simple personal Kanban board

ここ数日プロジェクト管理絡みの記事を続いて書いています。

今日もプロジェクト管理用ツールの話題の続きで。

 

Backlogでの一番のメリットと感じているAPI公開。

APIを使うことでCLIでBacklogのスペースを操作することができるようになります。

同じような操作とかはGUIでやるのは大変なので、そういうルーチンワーク的なものはCLIでやりたいですよね。

ということで今日はBacklog APIを使うのに必要な情報をまとめておきます。

 

概要

やろうとしていることはRubyスクリプトを使ってプロジェクトを作ろうと思います。

なので

  • Gemのインストー
  • backlog_kitの使い方を確認
  • API Keyを発行

の順番でやっていきます。

 

Gemのインストー

BacklogをRubyで使う場合は backlog_kit を使います。

github.com

 

gemでインストールしてもいいですが、bundlerで管理するようにしたいので、Gemfileを作って以下の内容を記載します。

gem 'backlog_kit'

そして bundle install --path vendor/bundle でインストールします。

yatta472:~/workspace $ bundle install --path vendor/bundle
Fetching gem metadata from https://rubygems.org/..........
Fetching version metadata from https://rubygems.org/..
Fetching dependency metadata from https://rubygems.org/.
Resolving dependencies...
Installing rake 12.0.0
Installing i18n 0.8.0

:
:
Installing backlog_kit 0.13.0
:
:

Bundle complete! 13 Gemfile dependencies, 60 gems now installed.
Bundled gems are installed into ./vendor/bundle.
yatta472:~/workspace $ 

うん。はいった。

 

backlog_kitの使い方を確認

インストールしたGemの使い方を確認。Githubのページにも基本的なことは書いてあるのでそちらをまずは確認。

github.com

 

それ以上のことをやろうと思った場合はGemのドキュメントを確認したほうがいいので、backlog_kitの使い方はドキュメントを確認します。

File: README — Documentation for backlog_kit (0.15.0)

よく使うのはClientなので、Clientを確認するのがいいと思います。

 

API Keyを発行

最後にAPIにアクセスするためのAPIキーの発行。

やり方はこちら。

www.backlog.jp

各ユーザごとにAPIキーが発行できるんですね。AWSみたい。

 

発行したAPIキーはこのような形で使うことになります。

client = BacklogKit::Client.new(
  space_id: 'emsk',
  api_key: '1234567890abcdefghij1234567890abcdefghij1234567890abcdefghij1234'
)

(参考:Githubページ )

 

ここまでで準備としては完了。あとはコードを書くだけです。

 

次回ははコードを書きます

だんだんプログラミングの色が強くなってきましたね。

Ruby経由でAPIをたたいて操作ができるようになったので、次回は実際にコードを書いてBacklog API経由でプロジェクトを作ってみようと思います。

 

Backlogでプロジェクトを作って、課題を管理していくのだけれど、その際にも若干設計というものが必要になるかと思います。

どの単位でプロジェクトにするか、それとも課題にするか、カテゴリーはどういうものを準備して、マイルストーンをどういう扱いにするのか。その辺も作業を分解して考えていく必要があるかなと思います。

その辺はやっぱりプロジェクト管理の知識が必要になりますよね。

そんな時におすすめな本が「コンサル一年目が学ぶこと」。

コンサル一年目が学ぶこと

コンサル一年目が学ぶこと

題名はコンサルになっているけど、仕事をする上での必要な知識が存分に入っているので、プロジェクト管理にも必ずや役に立つ本だと思います。

Real Time Web Analytics