Node.js からJira のデータをクエリ
CData API Server とADO.NET Provider for JIRA(もしくは250+ の他のADO.NET Providers)を使って、Jira をOData エンドポイントして公開し、Node.js からシンプルなHTTP リクエストでクエリを実現します。本記事ではAPI Server を使ってJSON でフォーマットされたJira のデータをNode.js でリクエストする方法を説明します。
Jira データ連携について
CData は、Jira のライブデータへのアクセスと統合を簡素化します。お客様は CData の接続機能を以下の目的で活用しています：
- Issue、Project、Workflow などの Jira オブジェクトへの双方向アクセスを実現します。
- SQL ストアドプロシージャを使用して、Issue のステータス変更、カスタムフィールドの作成、添付ファイルのダウンロード・アップロード、時間追跡設定の変更・取得などの機能的なアクションを実行できます。
- ユーザー名とパスワード、OAuth、パーソナルアクセストークン、API トークン、Crowd または OKTA SSO、LDAP など、さまざまな方法で安全に認証できます。
多くのユーザーは、CData Sync を直接使用するか、SSIS や Azure Data Factory などのプラットフォームとの CData の互換性を活用して、Jira データをデータベースやデータウェアハウスに統合するために CData ソリューションを活用しています。また、Tableau や Power BI などのお気に入りの分析ツールからライブ Jira データの分析やレポートを行いたい方もいます。
お客様がビジネス上の問題を解決するために Jira データにシームレスに接続している方法については、ブログをご覧ください：Drivers in Focus: Collaboration Tools
はじめに
API Server の設定
以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなJira OData サービスを作成していきましょう。
Jira への接続
NodeJS からJira のデータを操作するには、まずJira への接続を作成・設定します。
- API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。
- 「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「Jira」を選択します。
- 事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
CData コネクタの追加方法はこちら >> - それでは、Jira への接続設定を行っていきましょう！
-
JIRA への接続には、User、Password およびURL を使います。URL はhttps://yoursitename.atlassian.net などです。
- 接続情報の入力が完了したら、「保存およびテスト」をクリックします。
JIRA への接続には、User、Password およびURL を使います。URL はhttps://yoursitename.atlassian.net などです。
API Server のユーザー設定
次に、API Server 経由でJira にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。
- 「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
-
次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
-
その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。
Jira 用のAPI エンドポイントの作成
ユーザーを作成したら、Jira のデータ用のAPI エンドポイントを作成していきます。
-
まず、「API」ページに移動し、
「 テーブルを追加」をクリックします。
-
アクセスしたい接続を選択し、次へをクリックします。
-
接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。
OData のエンドポイントを取得
以上でJira への接続を設定してユーザーを作成し、API Server でJira データのAPI を追加しました。これで、OData 形式のJira データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。
Node.js からJira OData フィードを利用
OData フィードはNode.js で簡単に使用できます。Node.js のHTTP クライアントを使用して、API Server のOData エンドポイントからJSON 形式のデータをリクエストしていきましょう。リクエストを行った後、レスポンスの本文を作成し、JSON.parse() 関数を呼び出してレコードに解析できます。
以下のコードはIssues データに対して認証されたリクエストを行います。 以下のURL の例では、ReporterDisplayName カラムの値がBob のレコードを検索する単純なフィルターを適用しています。
var http = require('http');
http.get({
protocol: "http:",
hostname:"MyServer.com",
port:MyPort,
path: "/api.rsc/Issues?$filter=" + encodeURIComponent("ReporterDisplayName eq 'Bob'"),
auth:'MyUser:MyAuthtoken'
},
function(res) {
var body = '';
res.on('data', function(chunk) {
body += chunk;
});
res.on('end', function() {
console.log(body);
var jsonData = JSON.parse(body);
});
}).on('error', function(e) {
console.log("Error: ", e);
});