Backlog/API/By/Ruby

Backlog/API/By/Ruby

Ruby から使ってみる

ライブラリ | Backlog | Nulab Developers ここに BacklogKit という Ruby 用のライブラリが紹介されていたのでそれを使ってやってみる。

2015-12-07 現在、APIのバージョンは 2 のようだ。

実行環境構築

例により rbenv を使ってインストールする

$ rbenv install -l

で最新版は 2.2.3 のようなのでインストールする。

$ rbenv install 2.2.3

OK.

$ rbenv global 2.2.3

backlog_kit のインストール

Bundler を使って管理したいのでインストール

$ gem install bundler

管理ファイルの作成

$ rbenv exec bundle init

内容はこれ

source "https://rubygems.org"

gem 'backlog_kit'

インストール

$ rbenv exec bundle install --path vendor/bundle

Gemfile.lock を見るとインストールされた backlog_kit のバージョンは backlog_kit (0.13.0) になっている。

クライアントの作成

APIをぶん投げる起点となるクライアントオブジェクトを作成する。作成するには space_id と api_key が必要になる。この space_id というのは

https://hogehogehoge.backlog.jp

の hogehogehoge にあたる部分になる。

api_key は https://hogehogehoge.backlog.jp/EditApiSettings.action のページで生成できるので生成してメモっておく

2つの情報を使って、クライアントオブジェクトを生成する。

require 'backlog_kit'
client = BacklogKit::Client.new(
    space_id: "hogehogehoge",
    api_key: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
)

Wiki のページ一覧の取得

Wikiページ一覧の取得 | Backlog API | Nulab Developers

pages = client.get('wikis', projectIdOrKey: 'hogehogehoge').body
pages.each do | page |
  p page
end

注意点としてはページ内容は取得できないということである。 このへんは遅延で取得する設計になるだろう。

backlog/api/by/ruby.txt · 最終更新: 2019-11-25 12:02 by ore