Axios と CData Connect AI で API に接続した Web アプリを構築

Axios は開発者が Web ブラウザや Node.js からサーバーに HTTP リクエストを送信できる JavaScript ライブラリです。CData Connect AI と組み合わせることで、Web アプリからライブAPI のデータにアクセスできます。この記事では、your API に接続し、Axios でライブAPI のデータにアクセスできる Web アプリを構築する方法を説明します。

Axios から your API に接続

Axios で API を操作するには、Connect AI から your API に接続し、ユーザーにアクセス権を提供し、API のデータ 用のワークスペースを作成する必要があります。

Connect AI から your API に接続

CData Connect AI はシンプルなポイントアンドクリックインターフェースでデータソースに接続できます。

1. Connect AI にログインして「Sources」をクリック、次に「 Add Connection」をクリック

2. 接続を追加パネルから「API」を選択

3. your API に接続するために必要な認証プロパティを入力します。

   To connect to your API, configure the following properties on the Global Settings page:

   • In Authentication, select the Type and fill in the required properties
   • In Headers, add the required HTTP headers for your API
   • In Pagination, select the Type and fill in the required properties

   After the configuring the global settings, navigate to the Tables to add tables. For each table you wish to add:

   1. Click "+ Add"
   2. Set the Name for the table
   3. Set Request URL to the API endpoint you wish to work with
   4. (Optional) In Parameters, add the required URL Parameters for your API endpoint
   5. (Optional) In Headers, add the required HTTP headers for the API endpoint
   6. In Table Data click " Configure"
   7. Review the response from the API and click "Next"
   8. Select which element to use as the Repeated Elements and which elements to use as Columns and click "Next"
   9. Preview the tabular model of the API response and click "Confirm"
4. 「Save & Test」をクリック
5. your API 接続の追加ページで「Permissions」タブに移動し、ユーザーベースのアクセス許可を設定します。

Personal Access Token の作成

REST API、OData API、または Virtual SQL Server を介して Connect AI に接続する場合、Personal Access Token（PAT）を使用して Connect AI への接続を認証します。アクセスの粒度を維持するために、サービスごとに個別の PAT を作成することをお勧めします。

1. Connect AI アプリの右上にある歯車アイコン（）をクリックして設定ページを開きます。
2. 設定ページで「Access Tokens」セクションに移動し、「 Create PAT」をクリックします。
3. PAT に名前を付けて「Create」をクリックします。
4. Personal Access Token は作成時にのみ表示されるため、必ずコピーして安全な場所に保存してください。

Axios 用に your API エンドポイントを設定

your API に接続したら、目的のテーブル用のワークスペースを作成します。

1. 「Workspaces」ページに移動し、「 Add」をクリックして新しいワークスペースを作成します（または既存のワークスペースを選択）。
2. 「 Add」をクリックしてワークスペースに新しいアセットを追加します。
3. your API 接続（例: API1）を選択して「Next」をクリックします。
4. 操作するテーブルを選択して「Confirm」をクリックします。
5. ワークスペースの OData サービス URL をメモしておきます（例: https://cloud.cdata.com/api/odata/{workspace_name}）。

接続、PAT、ワークスペースが設定できたので、Axios からAPI のデータに接続する準備が整いました。

Axios ワークフローで API のデータに接続

OData プロトコルを使用して Axios から CData Connect AI への接続を確立するには、以下のステップに従います。

1. Web アプリ用のプロジェクトディレクトリを作成します（例: ~/connect_cloud/）
2. ターミナルを開き、プロジェクトディレクトリに移動して以下のコマンドで node プロジェクトを初期化します:

   npm init -y

3. 以下のコマンドでプロジェクトに Axios 依存関係をインストールします:

   npm install axios

4. プロジェクトディレクトリに以下のコードを含む server.js ファイルを作成します。CData Connect AI のユーザー名（例: [email protected]）と PAT（前提条件で作成した PAT）を指定します。また、SELECT * FROM API1.SCHEMA.posts のようなデータクエリも指定する必要があります。

   server.js コード

         const axios = require('axios')
   
         const user = '[email protected]'
         const pat = '***********************************';
   
         //API エンドポイント
         const url = 'https://cloud.cdata.com/api/odata/{workspace_name}';
   
         //POST リクエストで送信するデータ
         const data = {
         "query":"SELECT * FROM {workspace_name}.SCHEMA.posts"
         };
   
         axios.post(url, data, {
         auth: {
         username: user,
         password: pat
         }
         })
         .then(response => {
         const rows = response.data.results[0].rows;
         const schema = response.data.results[0].schema;
   
         //カラム名の配列を作成
         const columnNames = schema.map(col => col.columnName);
   
         //各行をループして、カラム名と値をログ出力
         rows.forEach(row => {
         const rowObject = {};
         row.forEach((value, index) => {
         const columnName = columnNames[index];
         rowObject[columnName] = value;
         });
         console.log(rowObject);
         })
         })
         .catch(error => {
         console.error('Error:', error);
         });
       

5. ターミナルで以下のコマンドを実行してサーバーを起動します:

   node server.js

   クエリ結果が表示されます:

       { ID: 1, VALUE: -2 }
       { ID: 2, VALUE: 1 }
       { ID: 11, VALUE: null }
       { ID: 3, VALUE: 2 }
       { ID: 4, VALUE: 5 }
       ...

クラウドアプリケーションから API のデータへの簡易アクセス

これで、Axios からライブAPI のデータへの直接接続が確立されました。Axios のようなクラウドアプリケーションから 100 以上の SaaS、ビッグデータ、NoSQL ソースへの簡易アクセスについての詳細は、Connect AI ページを参照してください。