アセンブル・ビュー

API Designerは、アセンブリーを作成するために使用できるアセンブル・ビューを特徴として備えています。 アセンブリーを使用すると、簡単に API を調整して、アクティビティーの記録や特定のフィールドの編集などのコンポーネントを組み込むことができます。

ポリシー・アセンブリーを作成した後に、ドラフトの API を編集しながら、 「アセンブル」タブをクリックしてアセンブル・ビューにアクセスできます。このビューには、使用可能なコンポーネントをリストするパレット、コンポーネントを構成するために使用されるプロパティー・シート、およびアセンブリーのコンポーネントを配置して視覚化するために使用されるキャンバスが含まれます。

アセンブリーを作成するには、API の設計ビューの「ポリシー・アセンブリー」セクションで「アセンブリーの作成」をクリックします。

パレット

アセンブル・ビューの左側に表示されるパレットは、アセンブリーに含めることができる各種コンポーネントのリストです。 左上隅の「ポリシー・パレットの表示/非表示」アイコン 「ポリシー・パレットの表示/非表示」アイコン をクリックすることで、パレットを非表示にできます。

キャンバス

キャンバスを使用して、アセンブリー・フローのグラフィカル表現を作成できます。 さまざまなコンポーネントを左側のパレットから右側のキャンバス上の適切な場所にドラッグできます。 コンポーネントをドラッグすると、有効な位置が破線のボックスで表示されます。「アセンブル」タブで行った変更は、「ソース」タブに反映されます。

API 呼び出しは、キャンバスの左側の塗りつぶされていない円で実行され、キャンバスの右側の塗りつぶされた円に返されます。 この 2 つの間にコンポーネントを挿入して、呼び出しから受け取ったデータまたは応答によって返されたデータを変更することができます。 コンポーネントを追加するには、パレットでコンポーネントを選択し、キャンバス上でコンポーネントを移動するときに表示される破線のボックスの 1 つにドラッグします。

「Catch の表示」トグルを使用して、パレットでのエラー Catch の表示と非表示を切り替えることができます。Catch はアセンブリーの一部分であり、API 呼び出しによって対応する HTTP ステータス・コードが返されたときに適用されます。「Catch」アイコン 「Catch」アイコン をクリックすると、すべての Catch のプロパティー・シートが開きます。

「+」アイコンをクリックしてキャンバスの表示をズームインしたり、「-」アイコンをクリックしてズームアウトしたりできます。 キャンバスをサイズに適合させるには、「適合ズーム」アイコン 「適合ズーム」アイコン をクリックします。

このページの右上隅の「Catch の表示 (Show catches)」トグルを使用して、キャンバス上に Catch を表示するかどうかを指定できます。

「操作によるフィルタリング」アイコン 「操作によるフィルタリング」アイコン をクリックしてドロップダウン・リストから操作を選択することによって、キャンバスをフィルタリングして、特定の操作に適用されるパーツのみを表示することができます。 フィルターを削除するには、「操作フィルターのクリア」アイコン 「操作フィルターのクリア」アイコン をクリックします。

プロパティー・シート

アセンブリー内のコンポーネントをクリックして選択すると、右側のプロパティー・シートにそのコンポーネントの詳細が表示されます。 このペインでは、コンポーネントのプロパティーを構成できます。 プロパティー・シートで使用可能なオプションは、作業しているコンポーネントのタイプに固有のものです。 一部のコンポーネントでは、「オブジェクト・プロパティー (Object Properties)」をクリックし、ドロップダウン・メニューからプロパティーを選択することで、プロパティーの追加や削除ができます。

「メニューのピン留め」アイコン 「メニューのピン留め」アイコン をクリックして、プロパティー・シートをピン留めまたは解放することができます。

タイム・スタンプ・アイコン 最終更新: 2017 年 10 月 31 日