API を作成した後、API を API Gateway に公開する場合、DataService Studio で API をテストして、API のリクエストパラメータと戻り値がビジネス要件を満たしているかどうかを確認する必要があります。公開済みの API もテストできます。このトピックでは、開発中の API と公開済みの API をテストする方法について説明します。
背景
API をテストする場合、DataService Studio の共有リソースグループを使用して、データソースまたはバックエンドサービスにアクセスして API を呼び出します。 API 呼び出しの数と API 呼び出しの実行時間に基づいて、リソースグループに対して課金されます。請求の詳細については、「DataService Studio」をご参照ください。
開発中の API をテストする
DataService Studio ページの [サービス開発] タブで、開発中の API をテストできます。テストを実行する前に、API を作成または登録する必要があります。
DataWorks コンソール にログインします。上部のナビゲーションバーで、目的のリージョンを選択します。左側のナビゲーションウィンドウで、 を選択します。表示されるページで、ドロップダウンリストから目的のワークスペースを選択し、[DataService Studio に移動] をクリックします。
DataService Studio ページで、上部のナビゲーションバーの [サービス管理] をクリックします。[サービス管理] タブの左側のナビゲーションウィンドウで、[API の管理] をクリックします。[API の管理] ページの [公開済み API] タブで、テストする API を見つけ、[テスト] 列の [アクション] をクリックします。
API をテストします。
[API のテスト] ダイアログボックスで、API のすべてのリクエストパラメータを設定します。
[テスト] をクリックして、API テストをトリガーします。
[API のテスト] ページの右側にある [リクエストの詳細] セクションと [レスポンスの詳細] セクションに表示される情報を表示できます。
[API 呼び出しレイテンシ値] は、現在の API リクエストのレイテンシです。この値は、API パフォーマンスを評価するために使用されます。レイテンシが高い場合は、クエリロジックまたはデータソースを最適化することをお勧めします。
API テストが失敗した場合は、エラーメッセージを確認し、API 設定を変更してから、API を再テストします。
公開済みの API をテストする
DataService Studio ページの [サービス管理] タブで、公開済みの API をテストできます。テストを実行する前に、API を送信して公開する必要があります。詳細については、「API を公開する」をご参照ください。
[DataService Studio] ページで、右上隅にある [サービス管理] をクリックします。
左側のナビゲーションウィンドウで、[API のテスト] をクリックします。
ドロップダウンリストからテストする API を選択し、API のすべての [リクエストパラメータ] が設定されていることを確認します。
[テスト] をクリックして、API テストをトリガーします。[API のテスト] ページの右側にある [リクエストの詳細] セクションと [レスポンスの詳細] セクションに表示される情報を表示できます。
説明[API のテスト] ページでは、公開済みの API のみをテストできます。API のサンプルの成功レスポンスを更新することはできません。
API で [ページングされた結果] 機能が有効になっている場合、返された結果がソートされるかどうかはデータソースによって異なります。返された結果をソートするには、[コードレス UI] モードで [ソート用のフィールド] を設定できます。または、[コードエディタ] モードで SQL 文に
ORDER BYを追加して、返された結果をソートすることもできます。
次のステップ
開発中の API のテストを実行した後、API を公開できます。これにより、他のユーザーが API を呼び出すことができます。API を公開する方法の詳細については、「API を公開する」をご参照ください。