OpenAPI ファイルをインポートした REST API の追加

OpenAPI 定義ファイルを使用して、REST API を IBM® API Connect にインポートできます。

OpenAPI ファイルをインポートして REST API を追加するには、以下のステップを実行します。

1. ナビゲーション・ペインで 「開発」をクリックし、「追加」 > 「API」をクリックします。 「API の追加: 作成」画面が表示されます。
2. 「インポート」セクションで、「既存の OpenAPI」を選択して、「次へ」をクリックします。
3. ローカル・ファイル・システムからファイルをインポートするには、ファイルをドラッグ・アンド・ドロップするか、「参照」をクリックして、使用するファイルを選択します。 .json ファイル、.yml ファイル、および .yaml ファイルは、有効な OpenAPI 定義がそれらのファイルに含まれていれば、サポートされます。

   ウィザードによって YAML の妥当性検査が行われ、検査が成功したことを示すメッセージが表示されます。

   注: API Manager UI を使用している場合、名前とバージョンが既存の API 定義と同じである API をファイルで定義していると、インポート操作は失敗します。ただし、API Designer UI を使用している場合、API 定義は、ローカル・ファイル・システム内のファイル名によって一意的に識別されます。そのため、同じ API 名とバージョンを定義している別個の 2 つのファイルをインポートした場合、エラーは発生せず、同じ名前とバージョンの 2 つの API 定義が API Connect で作成されます。
4. 「次へ」をクリックします。
5. オプション: さらに開発およびテストを行うために API をすぐに使用する場合は、「API のアクティブ化」を選択します。
   注:

   • 「API のアクティブ化」オプションを選択すると、API Connect は以下のアクションを自動的に実行します。
     • ドラフト製品を作成して、API を製品に追加し、製品をサンドボックス・カタログに公開して、API を呼び出せるようにします。製品には、「api_title auto product」というタイトルが付けられます。後でドラフト製品を削除する場合、直接ドラフト製品を削除することはできないので注意してください。その場合は、ドラフト製品の代わりに API を削除すると、API と一緒にドラフト製品が削除されます。API 定義の削除を参照してください。製品を公開先のカタログから削除する場合は、これを別々に実行する必要があります。カタログからの製品の削除を参照してください。
     • サンドボックス・テスト・アプリケーションを製品にサブスクライブして、API をテスト環境で即時にテストできるようにします。API のテストについては、アセンブリー・テスト・ツールを使用した API のテストを参照してください。
   • サンドボックス・カタログでステージ、公開、または置換のアクションに対するライフサイクルの承認が有効になっている場合は、「API のアクティブ化」オプションを使用できません。このようなライフサイクルの承認が有効になっている場合、「API のアクティブ化」オプションを使用するには、それらを無効にする必要があります。ライフサイクルの承認の設定については、カタログの作成および構成を参照してください。
   • 「API のアクティブ化」オプションを使用するには、Product:Manage および Subscription:Manage の許可を持つロールが割り当てられている必要があります。 事前に提供されている開発者のロールには、デフォルトでこれらの許可があります。カスタム・ロールが割り当てられている場合は、これらの許可が必要です。 詳しくは、カスタム・ロールの作成を参照してください。
6. 「次へ」をクリックします。 「API のインポートの要約 (Import API Summary)」パネルに、YAML ファイルがロードされたこと、および有効であることが示されます。

   「API のアクティブ化」を選択した場合は、ウィザードによって API エンドポイント URL にデータが設定され、ユーザーが使用できるクライアント ID とクライアント・シークレットが表示されます。

7. 以下のいずれかのオプションを選択します。
   • API をさらに構成するには、「API の編集」をクリックします。詳しくは、API 定義の編集を参照してください。
   • この時点では API をこれ以上構成しない場合は、左矢印アイコン をクリックして「API および製品」ページに戻ります。その後、すぐに別のタスクに進むことができます。後で API を構成する方法について詳しくは、API 定義の編集を参照してください。