Flex Gateway新着情報
Governance新着情報
Monitoring API Manager対話型の API Console (API コンソール) コンポーネントには REST API とメソッドの情報が表示され、ユーザーが要求を送信してメソッドをテストできます。
エンドポイントはアルファベット順に表示されます。
コンソールコンポーネントには、API Console (API コンソール)、API Console Documentation (API コンソールドキュメント)、API Console Instances (API コンソールインスタンス)、API Console Navigation (API コンソールナビゲーション)、API Console Request Panel (API コンソールリクエストパネル) が含まれます。コミュニティビルダーで、同じページに複数のコンソールコンポーネントを追加できます。コンソールコンポーネントへの変更は、同じ API を表示するそのページの他のすべてのコンソールコンポーネントに表示されます。たとえば、API Console (API コンソール) で [Summary (概要)] タブを選択すると、同じ API を表示する同じページのすべての API Console (API コンソール) で [Summary (概要)] タブが選択されます。
このコンポーネントには、Anypoint Exchange からの公開 API インスタンスとドキュメントが表示されます。
API の仕様に OAuth 2.0 セキュリティが含まれている場合、ユーザーは [Credentials source (ログイン情報の取得源)] リストでクライアントアプリケーションを選択してクライアント ID とクライアントシークレットを自動的に入力するか、リストで [Custom credentials (カスタムログイン情報)] を選択してクライアント ID とクライアントシークレットを手動で入力します。
デフォルトでは、API コンソールは 2 メガバイト以下の要求をブラウザーから Salesforce Experience Cloud を介して API に送信します。サイズ制限なしで要求を許可する API インスタンスにブラウザーから直接要求を送信するには、[設定] > [カスタムメタデータ型] > [ACM API Console Configuration Metadata (ACM API コンソール設定メタデータ)] > [ACM API Console Configuration Metadata (ACM API コンソール設定メタデータ) を管理] > [ACM API Console Configuration (ACM API コンソール設定)] > [編集] を開き、[Browser Requests Enabled (ブラウザー要求有効)] を選択します。この設定は、コミュニティ内のすべての API インスタンスに適用され、モッキングサービスには影響しません。
API コンソールの次のパラメーターの値を指定できます。
表示する API を指定します。
API のドキュメントページを表示します。
ページの読み込み時に API エンドポイントのドキュメントを拡張します。
ユーザーが API リソースを絞り込み、検索語に一致するリソースのみを表示できるように、ナビゲーションパネルに検索バーを表示します。
すべてのエンドポイントを展開または折りたたむためのボタンをナビゲーションパネルに表示します。
概要リンクを削除し、ユーザーがエンドポイント名をクリックしたときに概要を表示します。
パネルの端にある矢印をクリックすることで、要求パネルを展開および折りたたみできるようにします。
フロート表示リンクの色を指定します。
ボタンテキストの色を指定します。
ボタンのフロート表示テキストの色を指定します。デフォルトはボタンのテキスト色です。
API コンソールの見出しのフォントファミリーを指定します。
エラーメッセージの色を指定します。
GET メソッド表示ラベルの背景色を指定します。
GET メソッド表示ラベルの色を指定します。
POST メソッド表示ラベルの背景色を指定します。
POST メソッド表示ラベルの色を指定します。
PUT メソッド表示ラベルの背景色を指定します。
PUT メソッド表示ラベルの色を指定します。
DELETE メソッド表示ラベルの背景色を指定します。
DELETE メソッド表示ラベルの色を指定します。
PATCH メソッド表示ラベルの背景色を指定します。
PATCH メソッド表示ラベルの色を指定します。
OPTIONS メソッド表示ラベルの背景色を指定します。
OPTIONS メソッド表示ラベルの色を指定します。
HEAD メソッド表示ラベルの背景色を指定します。
HEAD メソッド表示ラベルの色を指定します。
[API Console (API コンソール)] ナビゲーション項目 (API エンドポイントや API メソッドなど) の名前が長い場合、2 行目に折り返されます。デフォルトでは、word-break
CSS プロパティの値が break-word
に設定されているため、単語の末尾で改行されます。改行の動作を変更する手順は、次のとおりです。
API コミュニティマネージャーコントロールパネルで [Community Builder (コミュニティビルダー)] > [設定] > [詳細] をクリックします。
[ヘッドマークアップ] セクションで、[ヘッドマークアップを編集] をクリックします。
次のコードを挿入します。
<style>
api-navigation {
--api-navigation-list-item-word-break: break-word !important;
}
</style>
必要に応じて、api-navigation
を api-navigation
コンポーネントが含まれるセレクターに置き換えます。
必要に応じて、break-word
を word-break
CSS プロパティの有効な値に置き換えます。
このコンポーネントのエンドポイントまたは種類に直接リンクするには、URL クエリパラメーター method
、path
、type
を設定します。method
は小文字にする必要があります。type
は大文字と小文字が区別されます。method
や path
が定義されていて API 定義に存在する場合、type
パラメーターに関係なく、そこでナビゲーションが開きます。method
または path
が定義されておらず、type
が定義されていて API 定義に存在する場合、指定した type
でナビゲーションが開きます。例:
communityapi/a003D000001pQpjQAE/basicapi?method=get&path=/users/{id}
communityapi/a003D000001pQpjQAE/basicapi?type=Users
API Console Documentation (API コンソールドキュメント) コンポーネントは、Anypoint Exchange からの API に関するドキュメントを表示します。
API Console Documentation (API コンソールドキュメント) の次のパラメーターの値を指定できます。
表示する API を指定します。
API ドキュメントページを表示します。
GET メソッド表示ラベルの背景色を指定します。
GET メソッド表示ラベルの色を指定します。
POST メソッド表示ラベルの背景色を指定します。
POST メソッド表示ラベルの色を指定します。
PUT メソッド表示ラベルの背景色を指定します。
PUT メソッド表示ラベルの色を指定します。
DELETE メソッド表示ラベルの背景色を指定します。
DELETE メソッド表示ラベルの色を指定します。
PATCH メソッド表示ラベルの背景色を指定します。
PATCH メソッド表示ラベルの色を指定します。
OPTIONS メソッド表示ラベルの背景色を指定します。
OPTIONS メソッド表示ラベルの色を指定します。
HEAD メソッド表示ラベルの背景色を指定します。
HEAD メソッド表示ラベルの色を指定します。
API コンソールの見出しのフォントファミリーを指定します。
API Console Instances (API コンソールインスタンス) コンポーネントは、エンドポイントとも呼ばれる API の公開インスタンスのリストを表示します。
このコンポーネントには、Anypoint API Manager からの公開 API インスタンスが表示されます。
API Console Instances (API コンソールインスタンス) の次のパラメーターの値を指定できます。
インスタンスを表示する API を指定します。
API Console Navigation (API コンソールナビゲーション) コンポーネントは、API コンソールコンポーネントのナビゲーションを表示します。
このコンポーネントには、Anypoint Exchange からの公開 API インスタンスとドキュメントが表示されます。
API Console Navigation (API コンソールナビゲーション) の次のパラメーターの値を指定できます。
表示する API を指定します。
API のドキュメントページを表示します。
GET メソッド表示ラベルの背景色を指定します。
GET メソッド表示ラベルの色を指定します。
POST メソッド表示ラベルの背景色を指定します。
POST メソッド表示ラベルの色を指定します。
PUT メソッド表示ラベルの背景色を指定します。
PUT メソッド表示ラベルの色を指定します。
DELETE メソッド表示ラベルの背景色を指定します。
DELETE メソッド表示ラベルの色を指定します。
PATCH メソッド表示ラベルの背景色を指定します。
PATCH メソッド表示ラベルの色を指定します。
OPTIONS メソッド表示ラベルの背景色を指定します。
OPTIONS メソッド表示ラベルの色を指定します。
HEAD メソッド表示ラベルの背景色を指定します。
HEAD メソッド表示ラベルの色を指定します。
API Console Request Panel (API コンソールリクエストパネル) コンポーネントは、ユーザーがリクエストを送信して API をテストできるパネルを表示します。
このコンポーネントには、Anypoint API Manager からの公開および管理 API インスタンスが表示されます。
API Console Request Panel (API コンソールリクエストパネル) の次のパラメーターの値を指定できます。
表示する API を指定します。
API のドキュメントページを表示します。
GET メソッド表示ラベルの背景色を指定します。
GET メソッド表示ラベルの色を指定します。
POST メソッド表示ラベルの背景色を指定します。
POST メソッド表示ラベルの色を指定します。
PUT メソッド表示ラベルの背景色を指定します。
PUT メソッド表示ラベルの色を指定します。
DELETE メソッド表示ラベルの背景色を指定します。
DELETE メソッド表示ラベルの色を指定します。
PATCH メソッド表示ラベルの背景色を指定します。
PATCH メソッド表示ラベルの色を指定します。
OPTIONS メソッド表示ラベルの背景色を指定します。
OPTIONS メソッド表示ラベルの色を指定します。
HEAD メソッド表示ラベルの背景色を指定します。
HEAD メソッド表示ラベルの色を指定します。
リンクにカーソルを合わせたときのリンクの表示色を指定します。
ボタンテキストの色を指定します。
ボタンのフロート表示テキストの色を指定します。デフォルトはボタンのテキスト色です。
見出しのフォントファミリーを指定します。
エラーメッセージの色を指定します。
ユーザーがアプリケーションを選択して clientId
や clientSecret
のログイン情報値を入力できるようにするには、ログイン情報アノテーションをアプリケーション仕様に追加します。
/all-query:
get:
queryParameters:
query_id:
type: string
(credentialType): id
query_secret:
type: string
(credentialType): secret
/all-headers:
get:
headers:
header_id:
type: string
(credentialType): id
header_secret:
type: string
(credentialType): secret
サイトにアクセス権の要求のカスタム実装がある場合は、次のイベントをディスパッチしてアプリケーションセレクターを更新します。このイベントがない場合、ユーザーがアプリケーションを追加するたびにページを更新して、[Application (アプリケーション)] メニューにアプリケーションを表示しなければなりません。
this.dispatchEvent(new Event('acm:application_created_success', {bubbles: true}))