サンプル・コンポーネントの定義

オンラインで編集する

サンプル・コンポーネントは、API の仕様をより明確にするために API に追加できる再使用可能なサンプルです。

このタスクについて

注:
  • このタスクは OpenAPI 3.0 API 定義の構成に関連しています。 OpenAPI 2.0 API 定義の構成方法について詳しくは、 OpenAPI 2.0 API 定義の編集を参照してください。
  • OpenAPI 3.0 API は、 DataPower® API Gatewayでのみサポートされ、 DataPower Gateway (v5 compatible)ではサポートされません。
  • 現在の OpenAPI 3.0 サポートの制限について詳しくは、 IBM® API ConnectAI Gateway での OpenAPI 3.0 のサポートを参照してください。

このタスクは、 API Designer UI アプリケーションを使用するか、ブラウザー・ベースの API Manager UI を使用して実行できます。

サンプル・コンポーネントを使用するには、API 定義内の他の場所から参照する必要があります。

「ソース 」アイコン OpenAPI ソース・アイコンをクリックすると、いつでも直接、基盤となる OpenAPI のYAMLソースに切り替えることができます。 デザインフォームに戻るには、 フォームアイコンをクリックしてください フォーム・アイコン。

手順

  1. OpenAPI 3.0 API 定義の編集で説明されているように、編集のために API を開きます。
  2. 「コンポーネント」 を展開し、既に 1 つ以上のサンプル・コンポーネントが定義されている場合は、 「例」を展開します。
  3. 新しいサンプル・コンポーネントを作成することも、既存のサンプル・コンポーネントを編集することもできます。
    • サンプルコンポーネントを作成するには、 「サンプル」 の OpenAPI 3.0 API 追加アイコン 横にある追加アイコンをクリックし、「 サンプルの作成」 を参照してください。
    • 既存のサンプルコンポーネントを編集するには、ナビゲーションペインでそのサンプルコンポーネントの名前をクリックし、「 サンプルコンポーネントの編集」 を参照してください。