製品の API の参照

オンラインで編集する

IBM® API ConnectAI Gatewayで、製品に組み込む API のファイル・パスの詳細を指定します。

このタスクについて

API をプランに組み込む前に、まず製品記述の API セクションで API を参照する必要があります。

手順

API セクションを開始して、製品に組み込む API を参照します。 使用する構文は、以下のように、使用するユーザー・インターフェースによって異なります。
  • APIデザイナー ：
    apis:
  API_1_NameAPI_1_Version
    $ref: API_1_File_Path
  API_2_NameAPI_2_Version
    $ref: API_2_File_Path
  • APIマネージャー ：
    apis:
  API_1_NameAPI_1_Version
    name: 'API_1_Name:API_1_Version'
  API_2_NameAPI_2_Version
    name: 'API_2_Name:API_2_Version'
    ここで
    • API_n_name 変数は、API の名前であり、大/小文字が区別されます。
    • API_n_version 変数は、API のバージョンです。
    • API_n_File_Path 変数は、API の OpenAPI 表記を含む YAML ファイルのファイル・パスです。
以下の例では、完全なサンプル APIs セクションを示します。
apis:
  api11.0.0:
    name: 'api1:1.0.0'
  api21.0.0:
    name: 'api2:1.0.0'
  api31.0.0:
    name: 'api3:1.0.0'

OpenAPI 定義の作成に関する詳細については、 「 OpenAPI 定義ファイルの作成」 を参照してください。

インデントは例にあるように設定する必要があります。また、API は、参照できるように事前に作成しておく必要があります。

結果

これで、製品に組み込む API の参照が完了しました。 「Product」の完全なYAML表現の例については、「ProductのYAML表現の例 」をご覧ください。