このトピックでは、DataService Studio で関数をテスト、公開、使用する方法について説明します。関数をフィルターとして使用して、API リクエストと応答を処理できます。
前提条件
関数をテストする前に、関数を作成して保存していることを確認してください。詳細については、「関数の管理」をご参照ください。
制限事項
ワークスペースのオーナー、および Workspace Administrator、Develop、または O&M ロールを持つ RAM ユーザーのみが関数をテストできます。詳細については、「ワークスペースメンバーの追加とロール権限の管理」をご参照ください。
ステップ 1:関数のテスト
-
データサービス ページに移動します。
-
DataWorks コンソールにログインします。対象のリージョンで、左側のナビゲーションウィンドウでをクリックします。ドロップダウンリストからワークスペースを選択し、入力 データサービス をクリックします。
-
サービス開発 ページの関数リストで、開発中の関数をダブルクリックします。
-
-
関数の編集ページで、上部のツールバーにあるテストをクリックします。
## --- AviatorScript --- ## $0:入力パラメーターのデフォルト名。 ## 式はセミコロン「;」で区切る必要があります。 ## 例 1: ## $0.a:入力パラメーター「$0」から属性「a」を取得します。 ## $0.b[index]:入力パラメーター「$0」から配列「b」のインデックスを取得します。インデックスは式や変数にすることはできません。 ## 例 2: ## 入力:{"keyA":[1,2],"keyB":"value"} ## 関数:$0.keyA[0]=3; $0.keyB="new_value"; return $0; ## 出力:{"keyA":[3,2],"keyB":"new_value"} -
Function Test ダイアログボックスで、パラメーターを入力し、Confirm をクリックします。
下部のRun Resultsタブで実行ステータスを確認できます。テストが失敗した場合は、エラーメッセージを確認し、関数を適宜修正し、再度テストします。
ステップ 2:関数の公開
関数がテストに合格したら、公開できます。
-
サービス開発 ページの関数リストで、テストに合格した関数をダブルクリックします。
-
上部のツールバーで、Submission をクリックします。
-
関数の編集ページで、右側のナビゲーションウィンドウにあるVersionをクリックし、ステータスがCan Be Publishedのバージョンを見つけ、アクション列のPublishをクリックします。
説明関数を公開した後、関数の編集ページにある右側のナビゲーションウィンドウで Version をクリックして公開履歴を確認できます。その後、Version Details を表示するか、ロールバック をクリックできます。
ステップ 3:関数の使用
利用シーン
-
API のプレフィルターとして、関数は呼び出し中に API リクエストパラメーターを前処理できます。
-
API のポストフィルターとして、関数は API 応答をさらに処理および変換できます。
制限事項
-
API のプレフィルターとポストフィルターは、同じ関数タイプを使用する必要があります。両方とも Aviator 関数であるか、両方とも Python 関数である必要があります。
-
Python 関数の機能は現在アップグレード中です。そのため、新しい Python 関数の作成、クローン、公開は現在サポートされていません。
API フィルターとしての使用
-
サービス開発 ページで、 を展開します。
-
API をダブルクリックして編集ページを開きます。
-
右側のナビゲーションウィンドウで、Filter をクリックします。
Use Pre-filter または Use Post-filter チェックボックスを選択します。Function Type は Aviator Function がデフォルトです。事前フィルターまたは事後フィルターのドロップダウンリストをクリックして、1 つ以上の関数を選択します。複数の関数を追加した場合、それらの関数は追加した順序で実行され、API パラメーターを処理します。
説明-
フィルターは、API リクエストパラメーターを前処理したり、クエリ結果をさらに処理したりする 1 つ以上の関数で構成されます。
-
ドロップダウンリストに対象の関数が見つからない場合は、その関数が公開されていることを確認してください。また、新しい関数を作成して公開することもできます。詳細については、「関数の公開」をご参照ください。
-
-
Preview Responses Returned by API Operation をクリックして、フィルターの出力を確認します。