1. Homepage
  2. API Experience Hub
  3. API の検出とコンシューム

  4. API 詳細の表示

API 詳細の表示

[API Details (API 詳細)] ページを表示するには、ポータルのホームページまたは [APIs (API)] ページから API を選択します。 [API Details (API 詳細)] ページには、API に関する次の情報が表示されます。

  • Name (名前)

    API の名前。

  • Type (種別)

    API 種別は、AsyncAPI、HTML、REST、または SOAP です。

  • Contact email (連絡先メール)

    API の連絡先のメール。

  • Categories (カテゴリ)

    この API が属する定義済みカテゴリの名前と値。API には複数のカテゴリを設定できます。カテゴリは API をグループに編成し、参照と検出を改善します。カテゴリは Exchange で作成および管理されます。

  • Tags (タグ)

    この API に関連付けられた定義済みキーワードの名前。API には複数のタグを設定できます。タグは Exchange で作成および管理されます。

  • Description (説明)

    API の説明。

  • Asset version (アセットバージョン)

    API のバージョン。

  • Version state (バージョンの状態)

    この API のライフサイクル状態 (開発、安定、または非推奨)。

  • Instances (インスタンス)

    API のインスタンスの数。

  • Clients (クライアント)

    各 API のクライアントアプリケーションの数。

API Console は [API Details (API 詳細)] ページにあります。このコンソールコンポーネントは対話型であり、API 仕様とそのメソッドに関する情報が表示されます。エンドポイントはアルファベット順に表示されます。詳細は、​「API Console の使用」​を参照してください。

カテゴリとタグを表示する

API のカテゴリまたはタグを表示する手順は、次のとおりです。

  1. [API Details (API 詳細)]​ ページで、​[Categories (カテゴリ)]​ または ​[Tags (タグ)]​ をクリックして情報を表示します。

  2. [Categories (カテゴリ)]​ または ​[Tags (タグ)]​ を再度クリックして、リストを閉じます。

インスタンス情報を表示して URL をコピーする

API インスタンスの名前と URL を表示し、URL をコピーする手順は、次のとおりです。

  1. [API Details (API 詳細)]​ ページで、​[View instances (インスタンスを表示)]​ をクリックします。

  2. コピーアイコンをクリックします。

  3. [Close (閉じる)]​ をクリックします。

関連情報