/var/www/yatta47.log

/var/www/yatta47.log

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

Backlog APIをRuby経由で使ってプロジェクトを作成する

前回Gemをインストールしたので、これでBacklog APIをラップしてRubyから使えるようになりました。

yatta47.hateblo.jp

プロジェクトをGUIで作る場合は以下のサイトの手順になります。

http://www.backlog.jp/help/adminsguide/project-setting/userguide353.html

 

これが数個であれば手で頑張って作るのですがこれが10個、20個、30個・・・挙句50個ともなると初期設定で1回しかやらないとは言えどもめんどくさいという風に感じてしまいます。

なので、今回はコードでプロジェクトを作ってみようと思います。

※ 注意 ※

Backlogのフリープランだとプロジェクトは一つしか作れないのでご注意。

 

前準備

事前準備として、以下の準備をしておきます。

  • Backlogでスペースの作成
  • backlog_kitをインストール
  • APIキーの生成

事前準備については前記事を確認してください。

 

実際のコード

それではコードを書いていきましょう。

全文です。

require 'backlog_kit'

def createProject(key, name)
    params = {
        chartEnabled: true,
        subtaskingEnabled: true,
        useWikiTreeView: true,
        textFormattingRule: "backlog"
    }

    @client.create_project(key, name, params)
end


# ///////////
# main
# ///////////
@client = BacklogKit::Client.new(
    space_id: "test-space",
    api_key: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
)

createProject("11111_2222", "プロジェクトの名前")

createProjectという関数を作って、そこにKeyとProjectNameを渡す形です。

main.rbというファイル名で保存してあとは実行するのみ。

bundle exec ruby main.rb

これでKeyが「11111_2222」プロジェクトの名前が「プロジェクトの名前」というプロジェクトが作成されます。

非常にシンプル。

 

若干解説を。

少し迷ったのがparamsのところ。

この値は何を設定すればいいのか?については、Backlogの公式APIドキュメントを参考にします。

プロジェクトの追加 | Backlog Developer API | Nulab

APIリファレンス(2017/7/3現在)のスクショで説明すると、以下の表のパラメータ名のnameとkey以外のところをハッシュにして渡してあげます。

f:id:yatta47:20170701230430p:plain

それ以外は特に難しいところはなかったかなー。

 

次は一括登録する

API経由でプロジェクトを作るのもGemを使ってやれば非常に簡単にできましたね。

次回はこれをベースに、複数のプロジェクトを一括して登録していこうと思います。

 

実際にプロ管の本ではないですが、プロジェクトを管理するのにもおすすめな本が「コンサル一年目が学ぶこと」という本。

特に仕事の段取りを考えるっていう項目があるのですが、そこはBacklogで何を親課題として登録するのか、子課題の登録単位はどうするのかなどが役に立つと思います。

それではー。