API コールのシミュレーション

モッキングサービスは、デザインしている API への公開リンクを提供するために使用します。モッキングサービスは、API 仕様で定義されている応答 (HTTP 状況コードとペイロード例の両方) を返すため、テストや API の動作確認に便利です。

始める前に

API Designer で API 仕様を作成するプロジェクトの作業を行っている必要があります。

このタスクについて

API コールのシミュレーションは、問題のトラブルシューティングや、想定されるユーザを対象とした API のデモを API の実装前でも行えるようにしてくれる重要なデザインタスクです。API コールのシミュレーションは、API 仕様のパブリッシュ前であれば API Designer で、パブリッシュ後であれば Exchange で行うことができます。

モッキングサービスを有効にすると、実際の実装の代わりにテストで使用できるモックサービスが提供されます。すでにベース URI (RAML) またはベースパス (OAS) を指定してある場合は、モッキングサービスによってコメント化されます。モッキングサービスを無効にすると、サービスが使用したベース URI またはベースパスが削除され、元のベース URI またはベースパスがコメント解除されます。たとえば、RAML API 仕様のベース URI が http://jsonplaceholder.typicode.com である場合、モッキングサービスは次のように URI を一時的に置き換えます (https://anypoint.mulesoft.com/mocking/api/v1/links/ 等はモッキングサービスが使用する URI)。

#%RAML 1.0
title: placeholder
version: 1.0
baseUri: https://anypoint.mulesoft.com/mocking/api/v1/links/d0422e05-e779-4016-9d9e-027e50cd15a7
# baseUri: http://jsonplaceholder.typicode.com

モッキングサービスは、コードエディタ、ビジュアルエディタ、および Anypoint Exchange から実行できます。API 仕様をパブリッシュした後で Anypoint Exchange からモッキングサービスを実行する方法については、Anypoint Exchange ドキュメントの「REST API でのデータのシミュレーション」を参照してください。同トピックへのリンクは、このトピックの最後にある「関連情報」に記載されています。

API Designer の公開モック URI は、Exchange にも表示されます。あなたの API を見つけた他のユーザは、組み込み Exchange モッキングサービスを使用するか、または API 実装をテストするためのコードやツールで公開 URI を使用することで、API を試すことができます。

手順

API Designer のコードエディタを使用している場合:
1. エディタの右上隅にある [Mocking service (モッキングサービス)] スライダをクリックして、モッキングサービスを有効にします。
2. [API summary (API の概要)] パネルで、テストするエンドポイントを持つリソースを完全に展開します。
  
  結果: リソースを展開すると、1 つまたは複数のボタンが表示されます。ボタンの表示ラベルは、リソースの各要求種別に対応しています。
3. シミュレートする要求種別と一致するボタンをクリックしてください。
  
  結果: 要求種別、そのパラメータ、および返されるコードとメッセージに関する情報がパネルに表示されます。
4. エディタの右上隅にある [Try It (試す)] をクリックします。
  
  結果: エンドポイントの URI が表示されます。エンドポイントでパラメータが必要な場合は値を指定します。ヘッダーを表示したり、カスタムヘッダーを追加したりすることもできます。
5. [Send (送信)] をクリックします。
  
  結果: パネルの [Send (送信)] ボタンの下に結果が表示されます。
API Designer のビジュアルエディタを使用している場合:
1. エディタの右上隅にある [Mocking service (モッキングサービス)] スライダをクリックして、モッキングサービスを有効にします。
2. 左側のパネルで、テストするエンドポイントを持つリソースを選択します。
3. エディタの中央パネルの一番上で、テストする要求種別を選択します。
4. エディタの右下隅にある [Try It (試す)] をクリックします。
  
  結果: 右側のパネルに要求の URL が表示されます。また、エンドポイントが必要とするパラメータの値を指定するように要求されます。さらに、ヘッダを表示したり、カスタムヘッダーを追加したりすることもできます。
5. [Send (送信)] をクリックします。
  
  結果: パネルの [Send (送信)] ボタンの下に結果が表示されます。

次にすること

まだ API 仕様を Anypoint Exchange にパブリッシュしていない場合は、パブリッシュする前にモッキングサービスを無効にしてください。モッキングサービスを無効にすると、API コールで使用したベース URI またはベースパスが削除され、仕様で定義されているベース URI またはベースパスがコメント解除されます。