この記事は インフォマティカ Advent Calendar 2023 の記事として書かれています。
最初に
CAIでAPI開発する際に、RDBMSにアクセスして
テーブルのデータを挿入・更新したり、内容を取得してレスポンスを返すなど
実装することがあると思います。そんなときに便利な部品が DAS (データアクセスサービスコネクタ)です。
本記事は、前編である【設定編】の記事をご覧いただいた方を前提としておりますので
設定がまだの方は、上記のリンクからご覧ください。
アプリケーション接続の作成
DAS自体の設定が完了した後は、環境別に
アプリケーション接続の設定を行います。
「新規」→「アプリケーション接続」→「アプリケーション接続」をクリックします。
新規作成したアプリケーション接続で以下の項目を入力します。
- 名前（必須）： わかりやすい名前にしましょう、"ConnRDSAprojectProd" など
- タイプ（必須）： 設定したDASの設定を選択してください
（DASが選択肢に出てこない場合は、DASの設定がパブリッシュ済みか否かを確認します。） - 実行環境： データベースに接続可能な場所に配置されているSecureAgentを選択してください
- JDBC Driver（必須）： クラス名をフルパッケージで入力します。各JDBCドライバを提供しているベンダーのサイトで確認してください。Oracle Databaseに接続する場合は、"oracle.jdbc.driver.OracleDriver" となります。
- JDBC コネクションURL（必須）：データベースに接続するURLを記述します。Oracleの場合は、"jdbc:oracle:thin:@<ホスト名>:<ポート番号>:" になります。詳細は各ベンダーのJDBCのページを参照してください。
- ユーザ名（必須）：データベースユーザ
- パスワード（必須）：データベースユーザのパスワード
DASの設定は1つですが、アプリケーション接続はデータベースの環境ごとに
作成する必要があります。環境とは、本番用DB、検証用DB、開発用DB等です。
「テスト」ボタンをクリックし、「合格しました」が表示されることを確認します。
「パブリッシュ」ボタンをクリックし、パブリッシュが成功することを確認します。
プロセス（API）の作成
「新規」→「プロセス」→「プロセス」を選択し、新しいプロセスを作成します。
開始ステップ
「開始」ステップをクリックし、下部のペインで設定を行います
- 名前(必須)：大学の情報をすべて取ってくるという意味で"GetAllUnivs"等わかりやすい名前にします
「開始」タブで、「匿名アクセスを許可します」にチェックをいれ、「次で実行」がクラウドサーバであることを確認します。
「出力フィールド」タブで、「＋」ボタンをクリックし、このプロセスの返却値の設定を行います。
- 出力形式： ペイロード全体
- 名前： "allunivs"
- タイプ： タイプをさらに表示
「カスタムタイプ」を選択し、「Any」と「オブジェクトリストを許可」の両方にチェックをいれて「OK」ボタンをクリックします
下記のようになっていればOKです。
サービスステップ
「サービス」ステップを追加します
「サービス」タブで、下記の通り設定を行います。
- サービスタイプ：接続
- 接続：<上記で作成した”アプリケーション接続を選択します”>
- アクション： SELECT ALLを選択します。
（※画像では SELECT ALL UNIVになっておりますがご容赦ください）
割り当てステップ
「割り当て」ステップを追加します。
「割り当て」タブから「フィールドの追加」を選択し”allunivs”を選択し、「次を使用する...」では「計算式」を選択します。
ボタンをクリックし、式エディタを表示します。
「フィールド」タブから、"univ"を選択し、「追加」リンクをクリックし、「OK」ボタンをクリックします。
「保存」ボタンをクリックし、その後、「パブリッシュ」ボタンをクリックします。
プロセス(API)の実行
「プロパティの詳細」からREST APIのURLをコピーし、
POSTMANにURLを張り付けて実行します。
実行結果を確認します。
データベースにアクセスし、全件の情報が取得できていることが確認できます。
レスポンスのJSONの確認
しかしレスポンスを確認すると、不要な属性が含まれていることがわかります。「row」の属性以下をレスポンスとして返すにはどうすればよいでしょうか。
プロセスの修正（割り当て）ステップ
allunivsの計算式の式を、下記の通り変更します。"//row"を末尾に追加します。
- $output.univ
+ $output.univ//row
再度「保存」、「パブリッシュ」し、POSTMANで再実行すると。
大学の情報だけが、JSONの配列として返却されることがわかります。
このように、DASから返ってきた値をそのままレスポンスとして返すのではなく、
CAIのプロセス側で変換し、プロセスのレスポンスとして設定することが可能です。
最後に
最後まで記事をご覧いただきありがとうございました。
今後もCAIに関する情報をお届けできればと思います。