API Experience Hub Lightning コンポーネント

ビルダーで Lightning コンポーネントを追加および設定することで、API Experience Hub ポータルのページを設計できます。

これらの Lightning コンポーネントには、すべての Salesforce デジタルエクスペリエンスで使用可能な Lightning コンポーネントと、API Experience Hub でのみ使用可能な API Experience Hub Lightning コンポーネントの両方が含まれます。

各 API Experience Hub Lightning コンポーネントには異なる設定オプションがあり、異なる機能がポータルに追加されます。

多くの API Experience Hub Lightning コンポーネントには、Anypoint Platform からのデータが表示されます。ポータル管理者は、これらのデータ項目の一部 (API 参照名、説明、アイコンなど) を変更できます。API Experience Hub はこれらの変更を保存しますが、変更を Anypoint Platform に転送しません。

  • API Console (API コンソール)

    対話型の API Console (API コンソール) コンポーネントには REST API とそのメソッドに関する情報が表示されます。エンドポイントはアルファベット順に表示されます。

    コンソールコンポーネントには、API Console (API コンソール)、API Console Documentation (API コンソールドキュメント)、API Console Instances (API コンソールインスタンス)、API Console Specification (API コンソール仕様)、API Console Request Panel (API コンソールリクエストパネル) が含まれます。ビルダーで、同じページに複数のコンソールコンポーネントを追加できます。コンソールコンポーネントへの変更は、同じ API を表示するそのページの他のすべてのコンソールコンポーネントに表示されます。たとえば、API Console (API コンソール) で [Summary (概要)] タブを選択すると、同じ API を表示する同じページのすべての API Console (API コンソール) で [Summary (概要)] タブが選択されます。

    このコンポーネントには、Anypoint Exchange からの公開 API インスタンスとドキュメントが表示されます。

  • Asset Detail Header (アセット詳細ヘッダー)

    Asset Details Header (アセット詳細ヘッダー) コンポーネントは、アイコン、名前、連絡先メール、説明などが含まれる API ヘッダーを表示します。

    表示される API アイコン、名前、説明は、コミュニティに API バージョンを追加するときに API Experience Hub のコントロールパネルで設定されます。連絡先メールは、Anypoint Exchange で設定されます。

    API Header (API ヘッダー) の次のパラメーターの値を指定できます。

  • アセットバージョン

    1 つのバージョンのみが表示される場合、Exchange からの API バージョンが表示されます。

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

    API バージョンのライフサイクル状態が表示されます。

  • Asset Documentation Viewer (アセットドキュメントビューアー)

    API Documentation Viewer (API ドキュメントビューアー) コンポーネントは、Anypoint Exchange からの API のドキュメントを表示します。ドキュメントは複数のページで構成され、各ページは複数のセクションで構成されることもあります。

  • Assets Carousel (アセットカルーセル)

    API Carousel (API カルーセル) コンポーネントは、水平方向にスクロール可能な API カードのセットを表示します。各カードには、API が表示されます。

  • Assets Catalog (アセットカタログ)

    API Catalog (API カタログ) コンポーネントは、API Portal で使用可能なすべての API を探索する対話的な方法を API コンシューマーに提供します。API Carousel (API カルーセル) には、ページに分割された行と列に API カード、および表示する API をタイプと検索語で絞り込むコントロールが表示されます。各カードには、API が表示されます。カタログを使用すると、ユーザーは多数の API バージョンを表示して探索できます。

  • Search Box (検索ボックス)

    API Experience Hub の Search Box (検索ボックス) コンポーネントを使用すると、ユーザーは Salesforce Experience Cloud に存在するコンテンツ (ナレッジ記事、サポートケース、お知らせなど) および Anypoint Platform に存在するコンテンツ (API やクライアントアプリケーションなど) の両方を検索できます。ナレッジ記事、サポートケース、お知らせは現在使用できません。

  • Search Results (検索結果)

    API Experience Hub の Search Results (検索結果) コンポーネントは、Search Box (検索ボックス) コンポーネントにユーザーが検索を入力した後の結果を表示します。