DataWorks:API のテスト

前提条件

開始する前に、以下の条件を満たしていることを確認してください。

• テスト対象の API を作成または登録済みであること（開発中の API の場合）

• API を提出および公開済みであること（公開済みの API の場合）。詳細については、「API の公開」をご参照ください。

開発中の API のテスト

公開前に、[サービス開発] タブで API をテストし、パラメーターと応答の問題を早期に検出してください。

1. DataWorks コンソール にログインします。上部ナビゲーションバーからリージョンを選択し、左側ナビゲーションウィンドウで データ分析とサービス > DataService Studio を選択します。ドロップダウンリストからワークスペースを選択し、DataService Studio へ移動 をクリックします。

2. 上部ナビゲーションバーで サービス管理 をクリックします。左側ナビゲーションウィンドウで API の管理 をクリックします。公開済みの API タブで該当の API を見つけ、操作 列の テスト をクリックします。

3. API のテスト ダイアログボックスで、API のリクエストパラメーターを設定します。

4. テスト をクリックします。テスト中の API ページ右側の リクエストの詳細 および 応答の詳細 セクションに表示される情報を確認できます。テストが失敗した場合は、エラーメッセージを確認し、API の設定を更新して再テストを実行してください。

   • API 呼び出しのレイテンシー：リクエスト送信から応答受信までの時間です。レイテンシーが高い場合は、パフォーマンス上の課題が存在する可能性があります。クエリのロジックまたはデータソースを最適化して、レイテンシーを低減してください。

公開済みの API のテスト

本番環境での動作を検証するため、サービス管理 タブから公開済みの API をテストします。

1. DataService Studio ページの右上隅にある サービス管理 をクリックします。

2. 左側ナビゲーションウィンドウで API のテスト をクリックします。

3. ドロップダウンリストから API を選択し、すべての リクエストパラメーター を設定します。

   

4. テスト をクリックします。テスト中の API ページ右側の リクエストの詳細 および 応答の詳細 セクションに表示される情報を確認できます。

   説明

   • API のテスト ページでは、公開済みの API のみがサポートされます。このページからはサンプル成功応答を更新できません。

   • API で ページングによる結果返却 が有効になっている場合、結果の並び順はデータソースに依存します。並び順を制御するには、ソート用フィールド を コードレス UI モードで設定するか、コードエディタ モードで SQL ステートメントに ORDER BY 句を追加してください。

次のステップ

API が期待通りに動作することを確認した後は、他のユーザーが呼び出せるよう公開してください。手順については、「API の公開」をご参照ください。