API プロパティーの設定

オンラインで編集する

API Connect ポリシーの動作を制御するために使用できる、事前に提供されている API プロパティーに加えて、独自の API プロパティーを定義することができます。 定義したプロパティーは、API 定義で参照できます。

このタスクについて

注: このタスクは、 OpenAPI 2.0 API 定義の構成に関連しています。 OpenAPI 3.0 API 定義の構成方法について詳しくは、 OpenAPI 3.0 API 定義の編集を参照してください。

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

API プロパティーには、プロパティー名、値、およびオプションのプロパティー値の適用先カタログがあります。 各種ポリシーに関連する、あらかじめ定義されたAPIプロパティの一覧については、 「APIプロパティ」 を参照してください。
注: 定義されると、API プロパティーは読み取り専用になります。

API定義内でプロパティを参照する方法については、. API Connectの「変数参照」を参照してください。

カタログに固有のプロパティーを定義し、そのカタログ内のどの API でも参照できるようにすることもできます。詳しくは、 カタログの作成および構成を参照してください。 API プロパティーと同じ名前の Catalog プロパティーを定義すると、API プロパティーが Catalog プロパティーよりも優先されることに注意してください。

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

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

手順

  1. OpenAPI 2.0 API 定義の編集の説明に従って、編集のために API を開きます。
  2. 「ゲートウェイ」 タブを選択し、 「ゲートウェイおよびポータルの設定」 を展開し、既に 1 つ以上の API プロパティーが定義されている場合は、 「プロパティー」を展開します。
  3. API プロパティーを構成します。
    • 新規の API プロパティーを定義するには、以下のステップを実行します。
      1. ナビゲーションペインの 「プロパティ」 の横にある OpenAPI 2.0 API 追加アイコン 追加アイコンをクリックします。
      2. 以下の情報を指定します。
        • プロパティー名: プロパティーの名前を入力します。この名前は、プロパティーの参照に使用されます。 API プロパティーの名前では、文字セット [A-Za-z0-9_-]+がサポートされています。 スペースを使用できます。
        • 「プロパティー値」: プロパティーのデフォルト値。 プロパティーのデフォルトをヌル値にする場合は、ブランクのままにします。
        • 説明 (オプション): プロパティーの説明。 リッチテキストの表現には、 CommonMark 構文を使用できます。
        • プロパティー値を非表示にする場合、またはユーザー・パスワードを不注意から保護する場合は、 「プロパティー値は Base64 エンコード済み」 を選択します。
          注: プロパティー値をエンコードすると、その値は Base64 エンコード形式で保存されます。暗号化 されません 。 その後、「エンコード済み」チェック・ボックスをクリアすると、元のプロパティー値がエンコードされていない形式で復元されます。
      3. 「作成」 をクリックします。
    • 既存の API プロパティーを変更するには、ナビゲーション・ペインで対象のプロパティー名をクリックします。 その後、任意の構成設定を変更できます。
  4. 変更内容を保存するには、 「保存」 をクリックします。