PHP のOData SDK を使用したGitLab のデータのクエリ

加藤龍彦
加藤龍彦
デジタルマーケティング
API Server とOData PHP SDK を使用して、エンティティをオブジェクトとしてモデリングすることでPHP でGitLab エンティティを手軽に使用。



CData API Server は、ADO.NET Provider for API（またはその他の240+ ADO.NET Providers のデータ）と組み合わせることで、GitLab のデータをWeb サービスとして公開します。下記の手順に従って、GitLab のデータをPHP オブジェクトとして使用しましょう。

API Server の設定

以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなGitLab OData サービスを作成していきましょう。

GitLab への接続

PHP からGitLab のデータを操作するには、まずGitLab への接続を作成・設定します。

  1. API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。 接続を追加
  2. 「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「GitLab」を選択します。
  3. 事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
    CData コネクタの追加方法はこちら >>
  4. それでは、GitLab への接続設定を行っていきましょう！ 接続設定

  5. まず、Profile 接続プロパティをディスク上の GitLab プロファイルの場所に設定します（例：C:\profiles\GitLab.apip）。次に、ProfileSettings 接続プロパティを GitLab の接続文字列に設定します（以下を参照）。

    GitLab API プロファイル設定

    GitLab の User Settings > Access Tokens でパーソナルアクセストークンを作成し、必要なスコープ（例：

    read_api
    、
    api
    ）を選択します。

  6. 接続情報の入力が完了したら、「保存およびテスト」をクリックします。

GitLab に接続するには、GitLab アカウントの User Settings > Access Tokens から個人用アクセストークンを生成します。次に、以下を設定します。

  • Personal Access Token: GitLab アカウントで生成した個人用アクセストークン。

API Server のユーザー設定

次に、API Server 経由でGitLab にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。

  1. 「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
  2. 次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。 新しいユーザーの構成
  3. その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。 API Server のユーザー設定

GitLab 用のAPI エンドポイントの作成

ユーザーを作成したら、GitLab のデータ用のAPI エンドポイントを作成していきます。

  1. まず、「API」ページに移動し、 「 テーブルを追加」をクリックします。 テーブルを追加
  2. アクセスしたい接続を選択し、次へをクリックします。 接続の選択
  3. 接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。 接続からのテーブルの追加

OData のエンドポイントを取得

以上でGitLab への接続を設定してユーザーを作成し、API Server でGitLab データのAPI を追加しました。これで、OData 形式のGitLab データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。

API エンドポイント

GitLab に接続するには、GitLab アカウントの User Settings > Access Tokens から個人用アクセストークンを生成します。次に、以下を設定します。

  • Personal Access Token: GitLab アカウントで生成した個人用アクセストークン。

さらに、OData SDK for PHP との互換性のためにAPI Server を構成します。「Settings」をクリックし、OData セクションで「デフォルトバージョン」を2.0 に設定します。

API Server に接続するユーザーの認証トークンを取得

作成するOData サービスを決定したら、「Users」をクリックして任意のユーザーをクリックし、ユーザーの認証トークンを取得します。API Server は、認証トークンベースの認証を使用して、主要な認証スキームをサポートします。SSL を使用すれば、接続の認証だけでなく、暗号化も可能です。IP アドレスを使用してアクセスを制限することも可能です。デフォルトでは、ローカルマシンからの接続のみが許可されます。

わかりやすくするために、URL に認証トークンを設定してAPI Server への認証を行います。これはデフォルトでは有効になっていないため、API Server の構成ファイルであるsettings.cfg に以下の行を追加する必要があります。 

[Application]
AllowAuthTokenInUrl = true

settings.cfg ファイルはデータディレクトリに配置されています。.NET 版では、www の下のapp_data フォルダがデータディレクトリになっています。Java 版でのデータディレクトリの位置は、OS によって変わります。

  • Windows：C:\ProgramData\CData\API\
  • Unix or Mac OS X：~/cdata/API/

GitLab エンティティをPHP オブジェクトとして使用する

以下のステップに従ってOData PHP SDK を使用し、API Server によって公開されるWeb サービスに接続するプロキシクラスを作成します。

  1. 以下のようなコマンドにURL を渡します。 

    php C:\PHPLib\ODataphp\PHPDataSvcUtil.php /uri=https://your-server:8032/api.rsc/@your-authtoken/ /out=C:\PHPLib\ODataphp\APIEntities.php

    上記のコマンドは、OData エンドポイントからのレスポンスで返されたメタデータからクラスを定義し、指定したフォルダにクラス定義を出力します。

    API Server とOData SDK for PHP は、フォーム認証とWindows 認証をサポートします。API Server は、認証トークンを使用してOData エンドポイントへのアクセスを許可されたユーザーを認証します。HTTP Basic 認証で認証トークを指定するか、OData URL に追加することができます。

    許可されたユーザーは、API Server の「Users」セクションで設定できます。

  2. PHP のオブジェクト指向インターフェースを使用して、GitLab のデータへのアクセスを開始できます。以下のコードは、AccessRequests テーブルのレコードを作成し、リアルタイムデータを取得して、新しく作成されたレコードを表示します。 

    require_once 'APIEntities.php';
try{
  $svc = new CData();
  $accessrequests = new AccessRequests();
  $accessrequests->State = 'pending';
  $svc->AddToAccessRequests($accessrequests);
  $svc->SetSaveChangesOptions(SaveChangesOptions::None);
  $svc->SaveChanges();
  $response = $svc->accessrequests()->Execute();
  foreach($response->Result as $accessrequests)
    echo $accessrequests->Id."";
} catch (Exception $e) {    //catch errors from the API Server
  echo $e->getError(), "\n";
}

はじめる準備はできましたか？

詳細はこちら、または無料トライアルにお申し込みください：

CData API Server

この記事の内容

関連記事