Node.js からGitLab のデータをクエリ
CData API Server とADO.NET Provider for API(もしくは240+ の他のADO.NET Providers)を使って、GitLab をOData エンドポイントして公開し、Node.js からシンプルなHTTP リクエストでクエリを実現します。本記事ではAPI Server を使ってJSON でフォーマットされたGitLab のデータをNode.js でリクエストする方法を説明します。
API Server の設定
以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなGitLab OData サービスを作成していきましょう。
GitLab への接続
NodeJS からGitLab のデータを操作するには、まずGitLab への接続を作成・設定します。
- API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。
- 「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「GitLab」を選択します。
- 事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
CData コネクタの追加方法はこちら >> - それでは、GitLab への接続設定を行っていきましょう！
-
まず、Profile 接続プロパティをディスク上の GitLab プロファイルの場所に設定します（例：C:\profiles\GitLab.apip）。次に、ProfileSettings 接続プロパティを GitLab の接続文字列に設定します（以下を参照）。
GitLab API プロファイル設定
GitLab の User Settings > Access Tokens でパーソナルアクセストークンを作成し、必要なスコープ（例：
read_api
、api
）を選択します。 - 接続情報の入力が完了したら、「保存およびテスト」をクリックします。
GitLab に接続するには、GitLab アカウントの User Settings > Access Tokens から個人用アクセストークンを生成します。次に、以下を設定します。
- Personal Access Token: GitLab アカウントで生成した個人用アクセストークン。
API Server のユーザー設定
次に、API Server 経由でGitLab にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。
- 「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
-
次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
-
その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。
GitLab 用のAPI エンドポイントの作成
ユーザーを作成したら、GitLab のデータ用のAPI エンドポイントを作成していきます。
-
まず、「API」ページに移動し、
「 テーブルを追加」をクリックします。
-
アクセスしたい接続を選択し、次へをクリックします。
-
接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。
OData のエンドポイントを取得
以上でGitLab への接続を設定してユーザーを作成し、API Server でGitLab データのAPI を追加しました。これで、OData 形式のGitLab データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。
Node.js からGitLab OData フィードを利用
OData フィードはNode.js で簡単に使用できます。Node.js のHTTP クライアントを使用して、API Server のOData エンドポイントからJSON 形式のデータをリクエストしていきましょう。リクエストを行った後、レスポンスの本文を作成し、JSON.parse() 関数を呼び出してレコードに解析できます。
以下のコードはAccessRequests データに対して認証されたリクエストを行います。 以下のURL の例では、State カラムの値がpending のレコードを検索する単純なフィルターを適用しています。
var http = require('http');
http.get({
protocol: "http:",
hostname:"MyServer.com",
port:MyPort,
path: "/api.rsc/AccessRequests?$filter=" + encodeURIComponent("State eq 'pending'"),
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);
});