API Console の使用

API Console は、REST API とそのメソッドに関する情報を表示し、要求を送信してメソッドをテストできる対話型コンポーネントです。API Console は [API Details (API 詳細)] ページにあります。エンドポイントはアルファベット順に表示されます。

API Console には、オンボーディングプロセスや適応性にとって重要な API の仕様とドキュメントの情報が表示されます。開発者は API の使用法と統合方法を知っておくと役立ちます。

[Specification (仕様)] ペインには REST API の REST 仕様の HTTP 関数のナビゲーションが表示されます。リソースやメソッドを確認することで、出力の形式や構造を理解できます。

[Documentation (ドキュメント)] ペインには API に関する対話型のドキュメントが表示されます。API ドキュメントには、各 API バージョンの詳細な説明が含まれます。このドキュメントは、API リリースサイクルで更新され、通常は開発チームが更新に深く関与します。要求の情報や応答を確認することもできます。

[Try it (試す)] ペインでは、モッキングサービスまたは API インスタンス URL を使用して REST API をテストできます。モッキングサービスを使用すると、要求と応答を処理する実際のサーバーを使用せずに、API 仕様で定義されたエンドポイントをテストできます。モッキングサービスでは、シミュレーションデータを API 関数に追加し、そのデータを使用して API をテストできます。すべての応答はサンプルデータです。API インスタンスを使用すると、サーバーと対話し、実際の要求と応答の実際のデータを取得できるようになります。