Dataphin:API のテストおよび公開

前提条件

開始する前に、API を作成済みであることを確認してください。詳細については、「API の作成」をご参照ください。

API 呼び出しおよびテストにおける直接接続モードとプロキシモード

Data Service では、API を直接接続モードおよびプロキシモードで呼び出すことができます。API が行レベルの権限と関連付けられている場合、認証方式は呼び出しモードによって異なります。

• 直接接続モード：行レベルの権限設定で、DataService Studio アプリケーションに対して行レベルの権限をリクエストします。このアプリケーションが認証に使用されます。

• プロキシモード：アプリケーションがユーザーの行レベルの権限を代理として使用して API を呼び出す必要がある場合、DataService Studio アプリケーションに対して行レベルの権限をリクエストします。その後、アプリケーションに対して API を呼び出すためのプロキシ権限をリクエストします。これにより、アプリケーションがユーザーに代わって API を呼び出せるようになります。

API テストページ上部の操作

• ドメイン名の表示：ページ上部でドメイン名を確認できます。このドメイン名は内部テスト専用です。クライアントからの呼び出しに使用されるドメイン名については、「ドメイン名の表示」をご参照ください。

• API の切り替え：ページ左上隅で、提出済みまたは公開済みの API を切り替えて表示できます。API 名または ID によるあいまい検索も可能です。検索対象は、現在のサービスプロジェクトでアクセス権限を持つすべての API です。システムは、現在のプロジェクトで直近にアクセスした（表示・編集・テスト・作成）9 つの API を推奨します。

• API 実行環境の切り替え：API のテスト用に実行環境を切り替えることができます。実行環境が開発環境の場合、テストには開発データソースが使用されます。実行環境が本番環境の場合、テストには本番データソースが使用されます。API が公開されていない場合は、本番環境への切り替えによるテストはできません。

  説明

  API が Basic モードであり、実行環境が開発環境の場合、テストには本番データソースが使用されます。

• API バージョンの切り替え：テストページ右上隅で、テスト用のバージョンを切り替えることができます。実行環境が開発環境の場合、提出済みのバージョンを選択できます。実行環境が本番環境の場合、公開済みのバージョンを選択できます。

手順 1：API のテスト

1. Dataphin ホームページの上部メニューバーで、サービス > API 開発 を選択します。

2. 左上隅でサービスプロジェクトを選択し、左側のナビゲーションウィンドウで API サービス > API を選択して、API ページに移動します。

   • API ページで、対象 API の **[アクション]** 列にある テスト アイコンをクリックして、API テストページに移動します。

   • API ページで、対象の API の [操作] 列で [その他 > バージョン管理] をクリックして [バージョン管理] パネルを開き、次に、対象の API の Actions 列にある [テスト] をクリックして API テストページに移動します。

3. API テスト ページで、パラメーター値を入力し、返されたパラメーターが期待通りであることを確認します。

   1. ビジネスリクエストパラメーター エリアでパラメーターを構成します。

      • 操作タイプが GET または LIST の場合、テスト入力値 はビジネスデータのフィールド値となります。リストパラメーターは、API 作成時に設定したリクエストパラメーターです。

      • 操作タイプが Create、Update、Delete の場合、リストフィールドは API 作成時に設定したリクエストパラメーターです。以下のようにパラメーターを追加、コピー、削除できます。

        • パラメーター項目の追加：パラメーター項目の追加 ボタンをクリックします。フィールド後のプロンプトに従ってパラメーター値を入力します。API の最大入力項目数 まで追加できます。

        • 一括追加：一括追加 をクリックします。ビジネスリクエストパラメーターの一括追加 ダイアログボックスで、パラメーターインスタンス値を入力します。各パラメーターグループは改行で区切ります。パラメーターの区切り文字およびテキスト修飾子を指定できます。

          • 区切り文字：フィールドを区切る文字です。カンマ (,)、セミコロン (;)、縦線 (|)、タブ文字 (\t)、またはカスタム文字（複数文字を入力可能）を使用できます。

          • テキスト修飾子：テキストフィールドを定義する文字です。「なし」、二重引用符 ("")、または一重引用符 ('') を選択できます。

        • 全画面入力：全画面入力 をクリックします。その後、下部の 1 行追加、5 行追加、または 10 行追加 をクリックして、行を迅速に追加します。

        • コピー：**[アクション]** 列の コピー アイコンをクリックします。システムが現在の行のパラメーター値をクローンし、クローンされた値で新しい行を末尾に追加します。

        • 削除：**[アクション]** 列の 削除 アイコンをクリックするか、リストからパラメーターを選択します。その後、下部の 一括削除 ボタンをクリックして、パラメーターの全行を削除します。

   2. 共通リクエストパラメーター エリアでパラメーターを構成します。

      • API が直接接続データソース API（クエリタイプ）またはサービスタイプ API の場合、API のリクエスト方式に応じて、異なるパラメーター（PageStart、PageSize、OrderByList）が表示されます。

        • ページングクエリが有効化されており、API の操作タイプが LIST の場合、PageStart、PageSize、OrderByList パラメーターが表示されます。API の操作タイプが GET の場合、OrderByList パラメーターのみが表示されます。

        • ページングクエリが無効化されており、API の操作タイプが LIST の場合、OrderByList パラメーターのみが表示されます。パラメーターを非表示 チェックボックスをクリアすると、PageSize および OrderByList パラメーターを表示できます。

      • API が直接接続データソース API（クエリタイプ）、サービスタイプ API、または複合 API であり、行レベルの権限が有効化されている場合、AccountType および DelegationUid パラメーターが表示されます。

      • API が直接接続データソース API（操作タイプ）の場合、ApiVersion パラメーターのみが表示されます。

        説明

        API をテストする際、入力パラメーターの長さは 1,000 文字を超えてはいけません。API を直接呼び出す場合、文字数制限はありません。

        パラメーター	説明	デバッグ入力値
        AccountType	プロキシモードで認証を行う場合、プロキシユーザーのアカウントタイプを指定する必要があります。 ACCOUNT_NAME：Dataphin 内のユーザー名。 USER_ID：Dataphin 内の固有 ID。 SOURCE_USER_ID：ソースシステムのアカウント ID。 説明 このパラメーターは、DelegationUid が設定されている場合にのみ必須です。このパラメーターが指定されていない場合、デフォルトのタイプは USER_ID です。	指定したプロキシユーザーのアカウントタイプを選択します。ACCOUNT_NAME、USER_ID、SOURCE_USER_ID のいずれかを選択できます。
        DelegationUid	アクセスを代理で行うユーザーです。選択した AccountType に基づいて対応するアカウント ID を渡す必要があります。このパラメーターを設定することで、プロキシモードでの認証が有効になります。	DelegationUid として使用できるのは、現在のテナントアカウントのみです。
        ApiVersion	呼び出す API のバージョンを指定します。デフォルトでは最新バージョンが使用されます。	テスト入力値は、ページ右上隅のバージョン切り替えで取得されます。 説明 実行環境が開発環境の場合、apiVersion パラメーターがサポートされます。呼び出せるのは提出済みの API のみです。
        PageStart	返されるデータの開始エントリ番号を定義します。	正の整数（例：2）を設定します。
        PageSize	1 ページあたりに返すデータエントリ数を定義します。	正の整数（例：56）を設定します。
        OrderByList	複数の返却パラメーターの並べ替え方法を定義します。指定しない場合、デフォルトは昇順です。	テスト入力値は、ビジネスリクエストパラメーター リストから取得する必要があります。
        ReturnTotalNum	結果内の行の総数を返すかどうかを定義します。ReturnTotalNum=true の場合、行の総数が返されますが、パフォーマンスに影響を与える可能性があります。	このパラメーターは、API の操作タイプが List かつページングクエリが有効化されている場合に表示されます。 正の整数（例：1000）を設定します。

   3. API が直接接続データソース API（クエリタイプ）、サービスタイプ API、または複合 API であり、行レベルの権限が有効化されている場合、行レベルの権限 エリアに、現在の API バージョンおよび環境に関連付けられた有効な行レベルの権限に関する情報が表示されます。これには、行レベルの権限の名称および説明が含まれます。

   4. オプションの返却パラメーター エリアで、返却パラメーターを選択します。返却パラメーターのリストは、選択した API バージョンに対応しています。

      • 操作タイプが GET または LIST の場合、API のテストには少なくとも 1 つの返却パラメーターを選択する必要があります。

      • 操作タイプが Create、Update、Delete の場合、すべてのパラメーターがデフォルトで選択されており、選択解除できません。

   5. API のプロトコルおよび返却エントリ数を構成します。

      パラメーター	説明
      プロトコル	API 作成時に HTTP および HTTPS の両方のプロトコルを選択した場合、API のテスト時にプロトコルを選択できます。
      返却件数	API のテスト時に返却するデータエントリ数を定義します： リクエスト方式が LIST の場合、返却件数 を選択できます。最大 10,000 件のデータエントリを返却できます。 リクエスト方式が GET の場合、返却件数 を変更できません。

4. 構成を完了したら、返却件数フィールド横の デバッグ または テスト をクリックして、指定した入力値で API 呼び出しをテストし、API の構成が業務要件を満たしていることを確認します。

   • API をテストする際、スクリプトの表示 をクリックして SQL スクリプトを確認できます。これにより、クエリ結果が期待されるスクリプト出力と一致するかどうかを比較できます。

     説明

     • 登録済み API やモデル API については、SQL スクリプトがないため、スクリプトを表示できません。

     • 複合 API を呼び出す場合、参照先 API が行レベルの権限制御を備えている場合、AccountType および DelegationUid パラメーターを参照先 API に渡す必要があります。

     • 複合 API をプロキシモードで呼び出す場合、複合 API に対してのみプロキシ権限をリクエストすれば十分です。

   • API の呼び出しモードが非同期モードの場合、テスト後にテスト結果エリアにクエリ結果が表示されます。テスト結果には、実行結果、ログ、コードなどの情報を確認できます。非同期クエリフローの詳細については、「非同期呼び出しプロセス」をご参照ください。

     • リクエスト結果の表示：API の呼び出し タブをクリックし、次に 返却結果 タブをクリックして、API 呼び出し本文で返されたリクエスト結果を表示します。

     • スクリプトコード：API の呼び出し タブをクリックし、次に スクリプトコード タブをクリックして SQL 文を表示します。

     • ログの表示：クエリステータスの取得 タブをクリックして、API 呼び出しの実行ログを表示します。API テストをキャンセルするには、クエリのキャンセル をクリックしてクエリ要求をキャンセルします。

     • クエリ結果の表示: [クエリ結果の取得] タブをクリックして、API 呼び出しの本文で返された最終的なクエリ結果を表示します。

5. 返却結果 または テスト結果 エリアでテスト結果を確認します。システムは、API_ID に基づいて直近の 10 件のテストおよびデバッグデータをキャッシュし、結果の比較が可能です。

   テストが失敗した場合は、「付録：エラーコードおよび解決策」をご参照ください。

6. API をテスト中に、API の編集、別のテストの実行、または API 権限の付与も可能です。

   • API の編集：下部の API の編集 ボタンをクリックして、現在の API の構成を変更します。詳細については、「API の編集」をご参照ください。

   • テスト：下部の テスト ボタンをクリックします。システムがテスト入力値で API を呼び出し、API の構成が業務要件を満たしていることを確認します。

   • API 権限の付与：下部の API 権限の付与 ボタンをクリックして、アプリケーションに API の権限を付与します。詳細については、「DataService Studio 権限管理」をご参照ください。

手順 2：API の公開

公開後、業務アプリケーションユーザーは DataService Studio の概要ページで API を見つけ、呼び出しの権限をリクエストできます。

付録：エラーコードおよび解決策