REST API のデータのシミュレーション

Exchange では、OAS または RAML REST API をテストするためのシミュレーションデータを提供できます。シミュレーションデータは、モッキングサービス機能で提供されます。

モッキングサービスは Exchange に表示されます。

  • アセット詳細画面の右側に表示される API Console 内。モッキングサービスでは、シミュレーションデータを API 関数に追加し、そのデータを使用して API をテストできます。

    API Console 内のモッキング

    このページには 2 つの URL が表示されます。左の URL は Design Center でも使用され、公開されています。右の URL は Exchange のみで使用され、認証が必要です。

  • API の各バージョンのインスタンスとしてリストされる。

    バージョン内のモッキングインスタンス
  • モッキングサービス URL がリストされる ​[API instances (API インスタンス)]​ ページにリストされる。

    [API Instances (API インスタンス)] のモッキングサービス URL

API でシミュレーションデータを受け入れる

  1. [Design Center] > [API Specification (API 仕様)] から、実装で返されるサンプルデータを指定します。または、テキストエディタで OAS (Swagger) 仕様を作成し、そこにサンプルデータを追加することもできます。

  2. REST 仕様で、成功した API コールの HTTP 状況コードを指定します。

シミュレーションデータで REST API をテストする

  1. Exchange で、REST API をクリックします。

  2. [GET] などの関数をクリックします。

  3. 画面の右側の API Console で、[Send (送信)] をクリックしてシミュレーションデータを API に送信します。

    REST 関数へのシミュレーションデータの送信

    Exchange によってデータが送信され、応答がリストされます。この例では、成功を示す HTTP 200 OK の状況が返され、シミュレーションデータを使用して API から送信されたデータがリストされます。

Was this article helpful?

💙 Thanks for your feedback!