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

API コールのシミュレーションは、問題のトラブルシューティングや、想定されるユーザを対象とした API のデモを API の実装前でも行えるようにしてくれる重要なデザインタスクです。シミュレーションは RAML の特定の要素に依存します。

  • 実際の実装が返すデータの例

  • API が返す HTTP 状況コードと応答

API への有効な要求をシミュレーションしてすべて成功した場合、API Console は状況コード 200 とサンプルデータを返します。

この手順では、API Console の URL を見つけます。ブラウザに URL を入力して API コールをシミュレーションします。この手順は、Mule フローを生成する APIkit プロジェクトの実行が終了した直後であることを前提としています。シミュレーションでは、JSON リソースをコンシュームしてユーザ情報を絞り込むコールを実行します。

  1. Studio で、[APIkit Consoles (APIkit コンソール)] に表示される基点 URL http://localhost:8081/console/ をクリックします。

    apikit consoles

    デフォルトのブラウザが開きます。

    API Console が表示され、API の概要と、バージョンやプロトコルなどのプロジェクトに関する情報が示されます。

    api console version info
  2. 必要に応じて、ハンバーガーメニューをクリックするか、ブラウザの幅を広くして、API リソースのシミュレーションコントロールを表示します。

    api console summary
  3. [API Summary (API の概要)] で、/users リソースの [GET] をクリックします。

    成功を示す HTTP 200 応答と、必要な /users リソースの JSON サンプルが表示されます。

    apikit response
  4. [API Summary (API の概要)] で、users リソースをクリックしてメソッドとサブリソースに関するドキュメントを表示します。

  5. [API Summary (API の概要)] で、/userbyid を展開します。/usersbyid リソースの [GET] をクリックし、[Try It.(試す)] をクリックします。

    [Parameters (パラメータ)] タブと [Headers (ヘッダー)] タブが表示され、クエリパラメータとヘッダーを要求に追加できます。

  6. [Show Optional Parameters (省略可能なパラメータを表示)] をオンにし、[Send (送信)] をクリックします。

    成功を示す HTTP 200 応答が表示されます。/usersbyid リソースの JSON サンプル (id 3 のユーザのユーザ情報) が表示されます。

    tryit

これで、エンドポイントを実装する準備ができました。

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub