要求と応答のテスト

システム API を使用する開発者が通常使用するツールでは、要求を送信して許容時間内に応答を受信できます。Guidewire では、Postman をお勧めします。このツールには、以下の機能があります。

  • ヘッダーとペイロードを含めて API 呼び出しを保存する。
  • 呼び出しのコレクションを保存する。
  • Swagger スキーマファイルをインポートすることで、スキーマのパスに対して呼び出しのコレクションを自動的に作成する。
  • コレクションをチームの他の開発者と共有する。

このツールの詳細およびダウンロードについては、https://www.postman.com/ を参照してください。

注意：Swagger UI は、ワーキング API に要求を送信して、応答を表示することもできます。ただし、このシステム API は大変堅牢であるため、要求に対する応答を受信するまでのパフォーマンス時間が許容時間を超えることがあります。Guidewire では、Swagger UI を使用するのは、システム API のドキュメントを表示する場合のみにすることをお勧めします。

チュートリアル：Postman 環境のセットアップ

システム API ドキュメントには一連のチュートリアルがあり、要求を送信して応答をレビューする方法の例を段階的にガイドします。これらのチュートリアルでは、以下の基本環境を想定しています。

  • ClaimCenter のデフォルトインスタンスがマシンにインストールされており、Demo サンプルデータセットのみがマシンに含まれている。
  • Postman の 1 つのインスタンス。

このチュートリアルでは、この環境をセットアップするプロセスを順を追って説明します。

注意：ClaimCenter のインスタンスが別のマシンにインストールされている場合、チュートリアルで提示しているエンドポイント URL を調整する必要があります。また、Demo サンプルデータ以外にデータを作成した場合、応答はチュートリアルで説明するものと異なることがあります。

チュートリアル手順

  1. Postman をインストールします（詳細については、https://www.postman.com/ を参照してください）。
  2. ClaimCenter を起動し、Demo サンプルデータを読み込みます。

最初の Postman 要求を送信して環境をテストできます。

  1. Postman を開きます。
  2. ［Launchpad］タブの右側の［+］をクリックして、新しい要求を開始します。
  3. Postman でのすべての要求は何らかの形式の承認を必要とします。
    1. ［権限］タブをクリックします。
    2. ［種類］ドロップダウンリストで［Basic Auth］を選択します。
    3. ［ユーザー名］フィールドに aapplegate と入力します。
    4. ［パスワード］フィールドに gw と入力します。
  4. ［Untitled Request］ラベルで GET が選択されていることを確認します（これはデフォルトの操作です）。
  5. ［Enter request URL］ フィールドに、「http://localhost:8080/cc/rest/common/v1/activities」の URL を入力します。
  6. 要求フィールドの右側にある［送信］ボタンをクリックします。

作業の確認

応答を受信すると、ペイロードが Postman のインターフェイスの下部に表示されます。環境が適切にセットアップされている場合、応答ペイロードの最初の数行は以下のようになります。

{
    "count": 25,
    "data": [
        {
        "attributes": {
            "activityPattern": "contact_claimant",
            "assignedGroup": {
                "displayName": "Auto1 - TeamA",
                "id": "demo_sample:31"
            },
            "assignedUser": {
                "displayName": "Andy Applegate",
                "id": "demo_sample:1"
            },

トラブルシューティング：応答なし

要求は、実行中のアプリケーションのみに送信できます。このドキュメントのすべてのチュートリアルでは、ClaimCenter が実行中であることが必要です。アプリケーションが実行されていないときに要求を送信すると、以下に類似したエラーが表示されます。

Could not get any response

There was an error connecting to http://localhost:8080/cc/rest/common/v1/activities.

トラブルシューティング： NotFoundException

特に明記されていない限り、すべてのチュートリアルで基本認証と aapplegate ユーザーを使用します。以下の例のように NotFoundException が発生した場合は、このユーザーの適切な認証情報を提供していないために発生した可能性があります。

"status": 404,
"errorCode": "gw.api.rest.exceptions.NotFoundException",
"userMessage": "No resource was found at path /common/v1/activities"