モッキングサービスを使用した API コールのシミュレーション

API モッキングサービスにより、API 仕様の動作をシミュレーションできます。モッキングサービスには、API へのテストリンクが用意されています。モッキングサービスは、API 仕様で定義されている応答 (HTTP 状況コードとペイロード例の両方) を返すため、テストや API の動作確認に便利です。

エンドポイントを API 仕様に追加すると、API Designer によって自動的に API へのリンクが生成され、このリンクはブラウザで使用できます。Anypoint Platform 外のユーザと共有できる公開リンクを有効にすることもできます。

モッキングサービスは Anypoint Platform の機能の 1 つであり、継続的に実行されます。モッキングサービスは、テキストエディタ、ビジュアルエディタ、および Anypoint Exchange から実行できます。API コールのシミュレーションは、API 仕様を Exchange にパブリッシュする前であれば API Designer で、パブリッシュ後であれば Exchange で行うことができます。

ベース URI (RAML) またはベースパス (OAS) を指定した場合、API Designer では、API コールをシミュレーションするときにベース URI またはモッキングサービスのいずれかを使用できます。API Designer では、API に対する変更が行われません。

開始する前に

API Designer に API 仕様が含まれるプロジェクトがある必要があります。また、API 仕様内で 1 つ以上のエンドポイントを定義している必要があり、各エンドポイントには 1 つ以上のメソッドが必要です。

内部 URL を使用して API へのコールをシミュレーションする

内部 URL にアクセスするには、要求 URL の一部として認証ヘッダーを指定する必要があります。認証ヘッダーを指定せずに API をテストするには、このプロジェクト用のモッキングサービス公開 URL を生成します。

  1. API Designer から、テストする API が含まれるプロジェクトを開きます。

    テキストエディタまたはビジュアルエディタを使用できます。

  2. プロジェクトのルートファイルを選択します。

  3. 右側のツールバーの ​[Documentation (ドキュメント)]​ アイコンをクリックします。

  4. ドロップダウンメニューから、​[Summary (概要)]​ を選択します。

  5. エンドポイントの名前をクリックします。

  6. API 仕様で ​baseURL​ を定義している場合、次の操作を実行します。

    • [Select server (サーバを選択)]​ ドロップダウンをクリックして、次のいずれかを選択します。

      • baseUri​: API 仕様で定義されている baseUri を使用します。

      • Mocking Service (モッキングサービス): API モッキングサービスを使用します。

  7. API のメソッドのいずれかをクリックして、​[Try it (試す)]​ をクリックします。

  8. (省略可能) テストするパラメータを指定してクエリします。

    クエリパラメータは名前と値のペアとして入力できます。

  9. [Send (送信)]​ をクリックします。

    API Designer に API で指定した HTTP 戻りコードが表示されます。または、​要求 URL​ をコピーして API をテストし、Web ブラウザまたは Postman に貼り付けることができます。

    モッキングサービスの内部 URL を使用する場合、URL の一部として認証ヘッダーを指定する必要があります。この状況を回避するには、モッキングサービス公開 URL を使用します。

デフォルトサーバとしてのモッキングサービスの設定

モッキングサービスは ​[Documentation (ドキュメント)]​ パネルで使用されるデフォルトサーバとして設定できます。これは、​[Select server (サーバを選択)]​ ドロップダウンに表示されるデフォルト値です。

  1. [Mocking Service Configuration (モッキングサービス設定)]​ をクリックします。

  2. [Select by Default (デフォルトで選択)]​ スライダをクリックします。

公開 URL を使用して API へのコールをシミュレーションする

認証ヘッダーを指定することなく、公開 URL を使用して API へのコールをテストします。この方法は、API を Anypoint Platform 外のユーザと共有する場合に便利です。

  1. API Designer から、テストする API が含まれるプロジェクトを開きます。

    テキストエディタまたはビジュアルエディタを使用できます。

  2. プロジェクトのルートファイルを選択します。

  3. 右側のツールバーの ​[Mocking Service Configuration (モッキングサービス設定)]​ アイコンをクリックします。

  4. [Make Public (公開する)]​ スライダをクリックします。

    API Designer によって API の公開 URL が生成されます。公開 URL を無効化すると、このオプションは無効になります。このオプションを再有効化すると、異なる URL が生成されます。

  5. (省略可能) 公開 URL の有効期限を設定します。

    1. [Set expiration date for public link (公開リンクの有効期限を設定)]​ をクリックします。

    2. 日付セレクタを使用して、公開リンクを期限切れにする日付を選択します。

Was this article helpful?

💙 Thanks for your feedback!