API への OpenAPI 拡張の追加

オンラインで編集する

JSON または YAML 拡張スキーマを API に追加することで、 OpenAPI 仕様を拡張できます。 OpenAPI 拡張は、カタログまたはカタログ内のスペースにインポートされてから、API スキーマに追加されます。

開始前に

OpenAPI 拡張をサンドボックス・カタログにインポートするか、拡張を追加する API が公開されるカタログにインポートします。 カタログへの OpenAPI 拡張のインポートを参照してください。

このタスクについて

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

API Manager UI のみ: このタスクを実行するには、 Api-Drafts:Edit 権限を持つロールが割り当てられている必要があります。 事前に提供されている「開発者」ロールには、デフォルトでこの許可が与えられています。カスタム・ロールが割り当てられている場合は、そのロールにこの許可が必要です。 詳しくは、 カスタム役割の作成を参照してください。

手順

  1. ナビゲーション ペインで [開発] API UI ナビゲーション・ペインの「開発」アイコン をクリックし、 [API ] タブを選択します。
  2. 作業する API のタイトルをクリックします。
  3. 「ゲートウェイ」 タブを選択し、 「ゲートウェイおよびポータルの設定」を展開して、 「拡張」をクリックします。
  4. この API で使用する OpenAPI 拡張を選択し、 「保存」をクリックします。
    注： ここにリストされている OpenAPI 拡張機能は、APIのテスト設定で定義されたカタログおよびゲートウェイサービスにインポートされたものです。詳細は、「 OpenAPI 拡張機能をカタログにインポートする 」および 「APIのテスト設定を指定する」 を参照してください。 また、API が公開されるカタログに OpenAPI 拡張をインポートする必要もあります。
  5. 以下のように、選択した OpenAPI 拡張スキーマ・ファイルで定義されているフィールドの値を使用して、API 定義の OpenAPI ソースを更新します。
    1. 「ソース 」アイコンをクリックしてください OpenAPI ソース・アイコン。
    2. 名前が x- で始まり、作成した OpenAPI 拡張の名前を参照する必要があるプロパティーを追加します。 OpenAPI 拡張 YAML ファイルで定義されたプロパティーの値を指定します。
      例については、 「API定義での拡張機能の参照」 を参照してください
    3. 完了したら、 「保存」 をクリックします。