製品をチェック

製品の詳細・30日間の無償トライアルはコチラ

CData Connect

ローコードアプリ開発プラットフォームOutSystems でGitHub 連携アプリを作成

CData Connect Server を使ってGitHub データの仮想OData API エンドポイントを作成して、OutSystems からGitHub データを使ったアプリを作成する方法。

杉本和也
リードエンジニア

最終更新日:2021-09-27

こんにちは!リードエンジニアの杉本です。

OutSystemsは、アプリケーションをUI 上で開発できるローコード開発プラットフォームです。この記事では、CData Connect Server を経由して OutSystems からGitHub に連携するアプリを作成する方法を説明します。

CData Connect Server は、GitHub データのクラウド to クラウドの仮想OData インターフェースを提供し、OutSystems からリアルタイムにGitHub データへ連携することができます。さらに、CData Connect Server は OpenAPI の定義ファイルを取得できるため、OutSystems で自動的にREST API Method を定義してスムーズにアプリ開発を行うことができます。
OutSystems からGitHub にデータ連携。

GitHub の仮想OData API エンドポイントを作成

まずCData Connect Server でデータソースへの接続およびOData API エンドポイント作成を行います。

  1. CData Connect Server にログインして、Databases をクリックします。 データベースを追加
  2. 利用できるデータソースアイコンから"GitHub" を選択します。
  3. GitHub に接続するために必要なプロパティを入力します。

    GitHub への接続には、OAuth 2 認証標準を使います。OAuth で認証するには、アプリを作成してOAuthClientId、OAuthClientSecret、およびCallbackURL 接続プロパティを取得する必要があります。詳細はヘルプドキュメントの「はじめに」を参照してください。

    接続を設定

  4. Test Database をクリックします。
  5. Permission -> Add をクリックして、新しいユーザーを追加し、適切な権限を指定します。
  6. API タブをクリックして OData API エンドポイントが生成されていることを確認します。
  7. 併せて OutSystemsにAPIリクエストの仕様を取り込むためにAPI タブにある「Open API」のファイルを以下から保存しておきましょう。
  8. Open API ファイルをダウンロード

OutSystems にCData Connect Server のコネクションを追加

続いてCData Connect Server への接続をOutSystems に追加します。OutSystems では RESTインターフェースを用いてCData Connect Server に接続します。

  1. 「Logic」タブから「Integrations」→「REST」を右クリックし「Consume REST API…」を選択します。ここから外部のREST APIのメソッドをコールする処理・Logic を登録できます。
  2. Consume REST API
  3. 今回は先程取得したOpen API Spec の情報を元に Logic を登録するので「ADD MULTIPLE METHODS」を選択し
  4. ADD MULTIPLE METHODS
  5. 保存したOpen API Spec のファイルを「UPLOAD FILE」から選んで「ADD METHODS」をクリックして登録します。
  6. Open API Spec ファイルのアップロード
  7. すると以下のようにOpen API Spec のファイルを元に、メソッド一覧が出てくるので任意のメソッドを選択して「FINISH」をクリックします。
  8. REST API Method 一覧
  9. これで CData Connect Server へのLogic を登録できました。
  10. Logicの登録を確認
  11. Logic の登録が完了すると、併せて Data のタブのStructures にデータモデルが登録されます。
  12. Structures データモデルの確認
  13. なお、これだけでは認証が通らないので、先程 CData Connect Server で登録したユーザーのID とToken をBasic Authentication のUsername とPassword に登録しましょう。
  14. 認証情報の設定

一覧画面を作成

それでは実際に CData Connect Server と連携した画面を作成していきましょう。

  1. 「Interface」タブに移動して「Add Screen」をクリックします。
  2. Screen の追加
  3. Screenのテンプレートは「Empty」で進めます。
  4. Screen テンプレートの選択
  5. Screenを登録したら、登録した対象のScreenから右クリックで「Fetch Data from Other Source」を選択します。これを先程登録したCData Connect Server の Logic と紐付けて、画面上からAPIをコールしてデータを表示します。
  6. Fetch Data From Other Source
  7. まず、利用するData Type を関連付けましょう。Out1のパラメータを選択して「Data Type」から CData Connect Server のAPI から生成されている Structures にあった一覧画面を取得するメソッドのレスポンスにあたるデータモデルを関連付けます。
  8. Data Type の関連付け
  9. そして、「Fetch Data from Other Source」のフローにCData Connect Server から全データを取得するメソッドをドラッグアンドドロップで配置します。
  10. メソッドを配置
  11. 取得したレスポンスは「Assign」機能を使って、Out1のパラメータに格納します。
  12. レスポンスをアサイン
  13. これでデータ取得周りの処理が完成です。あとはUI 部品として「Table」をScreen 上に配置し
  14. Table の配置
  15. Out1で定義したレスポンスデータモデルをドラッグ・アンド・ドロップで配置します。
  16. レスポンスデータモデルをTable と紐付け
  17. 「Sort Attribute」にある「value.」の部分は不要なので消してしまいましょう。
  18. 不要なAttribute の削除
  19. これだけで、CData Connect Server と連携した画面が作成できました。それでは画面中央上にある「Publish」ボタンをクリックして、動かしてみましょう。
  20. Publish ボタンのクリック
  21. 正常に起動すると、以下のような画面がブラウザで表示するので、登録したアカウントでログインします。
  22. OutSystems へのログイン
  23. 一覧画面が表示されて、以下のようにCData Connect Server 経由で取得したGitHub のデータがきれいに表示されました。
  24. 作成した画面のプレビュー

クラウドアプリケーションからGitHub データにOData API アクセスを実現

このように、CData Connect Serverを経由することで、API 側の複雑な仕様を意識せずにAPI 連携をしたアプリをOutSystems で開発できます。他にも多くのSaaS に対応するCData Connect Server の詳細をこちらからご覧ください。

トライアル・お問い合わせ

30日間無償トライアルで、CData のリアルタイムデータ連携をフルにお試しいただけます。記事や製品についてのご質問があればお気軽にお問い合わせください。