API の公開

ユーザー・インターフェースには、API を製品に追加し、その製品をカタログに公開するオプションが用意されています。 ドラフト製品を公開すると、その製品内の API が 開発者ポータル に表示され、アプリケーション開発者が使用できるようになります。 IBM® API Connect のシンジケーション機能は、カタログで スペース が有効になっている場合、そのカタログ内の スペース にのみ製品を公開できることを意味します。

開始前に

API Manager または API Designer のユーザー・インターフェース (UI) に、ステージング先のカタログがあることを確認します。 詳しくは、 カタログの作成および構成を参照してください。

カタログに 1 つ以上のゲートウェイ・サービスが構成されていることを確認します。

注: 特に明記されていない限り、カタログに対するこのトピック内のすべての参照は、カタログ内の スペース にも適用できます。 スペースの詳細については、API Connectでのシンジケーションの使用を参照してください。

このトピックで説明されている製品管理タスクを実行するには、API プロバイダー組織の所有者であるか、ターゲットのカタログまたは スペースに対する 製品 > 「管理」 権限が割り当てられている必要があります。 カタログまたは スペースに対する製品管理権限の構成については、 カタログの作成および構成 または スペースでのユーザー・アクセスの管理を参照してください。

このタスクについて

このタスクは、 API Designer UI アプリケーションを使用するか、ブラウザー・ベースの API Manager UI を使用して実行できます。 API Designer でオフラインで作業している場合、公開は使用できません。

API 定義ファイルの検証は、ステージング・プロセスまたは公開プロセス中に行われます。 実行される検証は以下のとおりです。
  • API Dev Tools Swagger Parser (https://www.npmjs.com/package/@apidevtools/swagger-parser) を使用した、 OpenAPI スキーマに対する妥当性検査。
  • IBM 拡張プロパティーに対する検証。
  • 意味の検証。以下の種類の検証が行われます。
    • API Connect ゲートウェイによって OpenAPI が強制される場合、スキームは HTTPSなければならず、またはヘッダーの API キーセキュリティスキームのパラメータ名は、 X-IBM-Client-Id または X-IBM-Client-Secret のいずれかでなければならないことを保証します。
    • OpenAPI が API Connect Gatewayによって強制されないようにするには、 ホスト を指定する必要があります。
    • 定義ファイル内のローカル参照 (つまり、 $ref プロパティーの値) の参照を解除し、これらがファイル内の有効な JSON ポインターであることを確認します。
注: 先読みアサーション (「(?」など) を含む 正規表現 を使用する Swagger プロパティーを持つ API を含む製品は、検証も公開もできません。 エラー・メッセージが返されます。 以下に例を示します。
Product has not been published!
The multipart 'openapi' field contains an OpenAPI definition with validation errors.
    definitions.properties.pattern Does not match format 'regex' (context: (root).definitions.properties.pattern, line: 0, col: 0)
400
注: API を定義する OpenAPI ファイルが $ref フィールドを使用して、別のファイルで定義されている OpenAPI コードのフラグメントを参照する場合、 $ref フィールドは、API を含む製品がステージングまたは公開される前に、ターゲット・ファイルの内容で置き換えられます ( $ref フィールドは、 API Connect デベロッパー・ツールキットを使用している場合にのみサポートされます)。 詳しくは、 $ref を使用した OpenAPI ファイル内のコード・フラグメントの再利用を参照してください。

手順

  1. ナビゲーション・ペインで、 ナビゲーション・ペインの「開発」アイコン 「開発」をクリックし、 「API」 タブを選択します。
    「開発」 ページが開きます。
  2. オプション: 複数のプロバイダー組織にアカウントがある場合は、 「組織」 メニューから、ステージングおよび公開用の新規プロバイダー組織を選択できます。
  3. API は、 「開発」 リスト・ページから公開することも、API 定義自体の中から公開することもできます。
    1. 「開発」 リスト・ページから API を公開するには、必要な API の横にあるオプション・メニュー・アイコン オプション・アイコン をクリックし、 「公開」を選択します。
    2. API 定義内から API を公開するには、以下のステップを実行します。
      1. 作業する API のタイトルをクリックします。
      2. 「開発」ページで、編集したい API の隣にあるメニューアイコン （3つの点）をクリックし、「APIの編集」 をクリックします。
      3. [テスト] タブ をクリックし、 [ターゲット構成] を選択します。

        環境設定ダイアログボックスが表示されます。

      4. 自動公開オプション をオンに設定します。
      注意： 自動公開設定は個々のAPIとは関連していません。 1つのAPIで自動公開設定を有効にすると、カタログやゲートウェイに関係なく、他のすべてのAPIにも適用されます。 そのため、各 API ごとに個別に設定を変更するのではなく、すべての API に対して単一の設定を選択することを強くお勧めします。
  4. 次のアクションのいずれかを選択してください。
    • API を新規製品に追加することによって API を公開するには、以下の手順を実行します。
      1. 「新規製品 - 新規製品を使用して公開します (New Product - Publish using a new product)」を選択します。
      2. プロンプトが出されたら、 「タイトル」 と 「バージョン」を入力します。
      3. 製品の「名前」は自動的に入力されます。 この名前は、CLI コマンドで製品を参照するために使用されます。 ツールキットのCLIリファレンスを参照してください。
      4. 次へ をクリックします。
    • 既存の製品に API を追加することによって API を公開するには、以下の手順を実行します。
      1. 「既存の選択 - 既存の製品を使用して公開します (Existing Product - Publish using an existing product)」を選択します。
      2. 使用する製品を選択します。
      3. 次へ をクリックします。
  5. 製品を公開する先のカタログを選択します。
  6. 選択したカタログで 「スペース」 が有効になっている場合は、必要な 「スペース」 を選択します。
    注: 選択できるカタログは、接続先の管理サーバーおよびプロバイダー組織用に定義されているカタログです。

    API管理 ユーザーインターフェースをご利用の場合は、接続の詳細は開いた API管理 URL とログインに使用したユーザーIDによって決定されます。 If you are using the APIデザイナー user interface, you provide the management server details and user ID in the login window that opens when you first launch APIデザイナー; see API Designerへのログイン.

    プロバイダー組織でカタログを作成する方法について詳しくは、 カタログの作成および構成を参照してください。

  7. 選択したゲートウェイ・サービスにのみ製品を公開する場合は、 「特定のゲートウェイ・サービスに公開」を選択してから、必要なゲートウェイ・サービスを選択します。 製品のゲートウェイ・タイプ設定とタイプが一致するゲートウェイ・サービスだけがリストされます。 ゲートウェイのタイプについては、API Connect ゲートウェイ・タイプを参照してください。
  8. 「公開」をクリックします。

結果

製品がカタログに公開されます。 API Managerで、カタログ内の製品の状態を表示できます。 API Designerから製品を公開した場合は、API Designer で使用したのと同じユーザー名とパスワードを使用して API Manager にログインしていることを確認してください。 API Manager UIで API Manager UI ナビゲーション・ペインの「管理」アイコン 管理をクリックし、必要なカタログを選択します。 製品が、「公開済み」の状態で表示されます。

製品のライフサイクルについては、 製品のライフサイクルを参照してください。

カタログに製品を公開するために承認が必要な場合は、公開の承認要求が送信され、製品が「保留」状態に移行します。この要求が承認されると、製品がカタログに公開されます。 承認が不要である場合、製品は直ちに公開されます。

注: 製品をカタログにステージングするために承認が必要な場合は、ステージ承認要求が送信されます。 この要求が承認されると、製品が「ステージング済み」状態に移行し、個別にカタログに公開しなければならなくなります。 カタログ内のステージング済み製品の公開については、 製品の公開を参照してください。

カタログの製品ライフサイクルの承認の構成については、 カタログの作成および構成を参照してください。 要求の承認については、 製品のライフサイクルとサブスクリプションの要求の承認を参照してください。

製品にプランが含まれていない場合、デフォルト・プランと呼ばれるプランがカタログ内の製品に自動的に追加されます。

注:
  • OpenAPI 3 API に応答ワイルドカードが含まれている場合 (これはサポートされません)、その API の公開は無効になります。 API を公開する前に、問題を修正する必要があります。
  • このカタログにインポートされていない ユーザー定義ポリシー を含む API が製品に含まれている場合、公開は失敗します。 製品を正常に公開するには、必要なカタログで ユーザー定義ポリシー が使用可能でなければなりません。 ユーザー定義ポリシー をカタログにインポートする方法について詳しくは、 カタログへのユーザー定義ポリシーのインポートを参照してください。