カタログ固有のプロパティー値の定義

オンラインで編集する

任意の API プロパティーに対して、特定のカタログに固有の値を定義することができます。 そのカタログに公開されたすべての API について、API プロパティーはカタログ固有の値を想定し、すべてのデフォルトのプロパティー値をオーバーライドします。

開始前に

カタログ固有の値を定義したい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 を使用して実行できます。

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

ヒント: 既にステージングまたは公開されている API で API プロパティーを追加または変更した場合、変更を有効にするには、更新された API を含む製品を再ステージングまたは再公開する必要があります。

手順

  1. OpenAPI 3.0 API 定義の編集で説明されているように、編集のために API を開きます。
  2. 「ゲートウェイ」 タブを選択し、 「ゲートウェイとポータルの設定」 を展開します。既に 1 つ以上のカタログ固有のプロパティー値が定義されている場合は、 「カタログのプロパティー」を展開します。
  3. カタログ固有のプロパティー値を構成します。
    • 新規のカタログ固有のプロパティー値を定義するには、以下のステップを実行します。
      1. ナビゲーションペインの 「カタログのプロパティ」 の横にある OpenAPI 3.0 API 追加アイコン 追加アイコンをクリックします。
      2. 選択したカタログの name フィールドに表示されているとおりに 「カタログ名」 を入力します。
        ヒント: 最良の結果を得るために、カタログのタイトルを選択する代わりに、カタログの名前を手動で入力してください。 カタログ名を使用する方が、そのタイトルを使用するよりも安全です。これは、タイトルがプロバイダー組織内で固有ではなく、後で変更される可能性があるためです (これにより、プロパティーとカタログの間の関連付けが解除されます)。 カタログの名前は、プロバイダー組織内で常に固有であり、変更することはできません。
      3. 「作成」 をクリックします。 指定されたカタログのカタログ・プロパティーの詳細が表示され、さらに編集を行うことができます。
      4. 「 プロパティーのオーバーライド」の横にある 「追加」をクリックします。
      5. 以下の情報を指定します。
        • プロパティー名: カタログ固有の値を定義する対象の API プロパティーの名前を入力します。 名前は、以前に定義されたAPIプロパティの名前と一致している必要があります。 「APIプロパティの設定」 を参照してください。
        • プロパティー値 (Property Value): カタログ固有のプロパティー値。 プロパティーのデフォルトをヌル値にする場合は、ブランクのままにします。
      6. 「作成」 をクリックします。
    • 既存のカタログ固有のプロパティー値を変更するには、ナビゲーション・ペインでカタログ名をクリックします。 その後、カタログ名を変更したり、プロパティーのオーバーライド設定を追加、変更、または削除したりすることができます。
  4. 変更内容を保存するには、 「保存」 をクリックします。