Flex Gateway新着情報
Governance新着情報
Monitoring API ManagerAPI の仕様とドキュメントの情報は、オンボーディングプロセスや適応性にとって重要です。開発者は API の使用法と統合方法を知っておく必要があります。ポータルの API Console (API コンソール) には、API の仕様とドキュメントが表示されます。API Console (API コンソール) は [API Details (API 詳細)] ページにあります。このコンソールコンポーネントは対話型であり、REST API とそのメソッドに関する情報が表示されます。エンドポイントはアルファベット順に表示されます。
[Specification (仕様)] ペインには REST API の REST 仕様の HTTP 関数のナビゲーションが表示されます。リソースやメソッドを確認することで、出力の形式や構造を理解できます。
[Documentation (ドキュメント)] ペインには API に関する対話型のドキュメントが表示されます。API ドキュメントには、各 API バージョンの詳細な説明が含まれます。このドキュメントは、API リリースサイクルで更新され、通常は開発チームが更新に深く関与します。要求の情報や応答を確認することもできます。
[Try it (試す)] ペインでは、モッキングサービスを使用して API をテストできます。モッキングサービスでは、シミュレーションデータを API 関数に追加し、そのデータを使用して API をテストできます。
API に関する情報を見つける手順は、次のとおりです。
[Home (ホーム)] または [APIs (API)] ページで、API を選択します。
[Specification (仕様)] ペインで、関数をクリックします。
[Documentation (ドキュメント)] ペインで、関数の概要を確認します。
[Request (要求)] タブを選択して、コード例、パラメーター、セキュリティ、ヘッダー、例、本文に関する情報を表示します。
[Response (応答)] タブを選択して、応答種別、例、ヘッダー、本文を表示します。
API をテストする手順は、次のとおりです。
[Home (ホーム)] または [APIs (API)] ページで、API を選択します。
[Specification (仕様)] ペインで、get
などの関数をクリックします。
[Try it (試す)] パネルで、[Select Server (サーバーの選択)] オプションから [Mocking Service (モッキングサービス)] を選択します。
[Send (送信)] をクリックしてシミュレーションデータを API に送信します。
API から返された応答を確認します。