OpenAPI 定義ファイルのインポートによる REST API の追加

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

開始前に

ファイルは、 OpenAPI 仕様のバージョン 2.0 またはバージョン 3.0 に準拠している必要があります。有効なファイル・フォーマットは、JSON と YAML です。

注: 先読みアサーション (「(?」など) を含む 正規表現 を使用する 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 Designer UI アプリケーションを使用するか、ブラウザー・ベースの API Manager UI を使用して実行できます。

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

API デザイナー UI を使用していて、例えば API Connectを使用して作成されたのではなく、外部 Web サイトからダウンロードした OpenAPI 定義ファイルを他の場所から使用する場合は、ファイルをローカルの API デザイナーディレクトリーにコピーするのではなく、ここで説明されているインポート・メカニズムを使用します。インポート操作により、 API デザイナーで必要な API Connect 固有のセクションが追加されます。

手順

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

ナビゲーションペインで [開発] をクリックし、 [追加] > [API] をクリックします。
「API タイプの選択」画面が表示されます。
API のベースとなる OpenAPI 仕様のバージョンに応じて、 OpenAPI 2.0 または OpenAPI 3.0 を選択します。
Import セクションで Existing OpenAPI を選択し、 Next をクリックします。
ファイルをインポートするには、以下のいずれかの方法を選択します。
- ファイルをドラッグ＆ドロップしてください
  別のウィンドウを開き、ファイルを選択します。ファイルを「ファイルの選択」ボックスにドラッグし、ファイルを解放します。
- ファイルを選択してください
  「ファイルの選択」ボックスをクリックします。ファイルを見つけて選択します。
- ファイルの URL
  Or specify a file URL フィールドに、ファイルの URL を入力または貼り付けます。オプションで、ファイルへのアクセスに必要な場合は、「ユーザー名」と「パスワード」を追加します。
有効な OpenAPI 定義が含まれている場合は、ファイル・タイプ .json、 .yml、および .yamlがサポートされます。
選択したファイルをインポートするには、「次へ」をクリックします。
ウィザードによって YAML の妥当性検査が行われ、検査が成功したことを示すメッセージが表示されます。
注:
- API Manager UI を使用している場合、既存の API 定義と同じ名前とバージョンの API がファイルで定義されていると、インポート操作は失敗します。ただし、 API Designer UI を使用している場合、API 定義はローカル・ファイル・システム内のファイル名によって一意的に識別されます。そのため、同じ API 名とバージョンを定義する 2 つの異なるファイルをインポートすると、同じ名前とバージョンを持つ 2 つの API 定義が API Connectに作成され、エラーは発生しません。
- 妥当性検査エラー・メッセージは英語でのみ表示され、翻訳されません。
オプション： 今後の開発やテストですぐにAPIを利用したい場合は、「APIを有効にする」を選択してください。
注:
- 「API のアクティブ化」オプションを選択すると、 API Connect は自動的に以下のアクションを実行します。
  - ドラフト製品を作成して、API を製品に追加し、製品をサンドボックス・カタログに公開して、API を呼び出せるようにします。製品のタイトルは、「api_title auto product」です。この製品は「開発」ビューには表示されず、ユーザーが直接削除することはできません。ただし、APIを削除すると、下書きの製品もAPIとともに削除されます。詳しくは「API定義の削除」を参照してください。製品は、公開先のすべてのカタログで表示されます。カタログから商品を削除したい場合は、別途操作を行う必要があります。詳しくは「カタログから商品を削除する」を参照してください
  - サンドボックス・テスト・アプリケーションを製品にサブスクライブして、API をテスト環境で即時にテストできるようにします。 API のテストについては、 API のテストを参照してください。
- ステージ、公開、または置換アクションについて、サンドボックスカタログでライフサイクル承認が有効になっている場合、Activate API オプションは使用できません。このようなライフサイクル承認が有効になっている場合、「 Activate API 」オプションを使用するには、それらを無効にする必要があります。ライフサイクル承認の設定に関する詳細については、「カタログの作成と設定」を参照してください。
- 「API のアクティブ化」オプションを使用するには、 Product:Manage 権限と Subscription:Manage 権限を持つ役割が割り当てられている必要があります。事前に提供されている開発者のロールには、デフォルトでこれらの許可があります。カスタム・ロールが割り当てられている場合は、これらの許可が必要です。詳しくは、カスタム・ロールの作成を参照してください。
「次へ」をクリックします。「インポート API の要約 (Import API Summary)」パネルに、YAML ファイルがロードされ、有効であることが示されます。

「API のアクティブ化」を選択した場合は、ウィザードによって API エンドポイント URL にデータが設定され、ユーザーが使用できるクライアント ID とクライアント・シークレットが表示されます。
次のオプションのいずれかを選択します:
- API をさらに構成するには、「API の編集」をクリックします。詳しくは、 API 定義の編集を参照してください。
- この時点では API をこれ以上構成しない場合は、パンくずリスト内の「開発」リンクをクリックしてウェルカム・ページに戻ります。その後、すぐに別のタスクに進むことができます。後で API を構成する方法について詳しくは、 API 定義の編集を参照してください。

結果

API 定義がインポートされると、「開発」ページの API 定義のリストにその定義が表示されます。 API Designerの場合、API および製品の仕様は、ログイン時に指定したディレクトリーに保管されます。 API Managerの場合、API および製品の仕様は管理サーバーに保管されます。

次のタスク

API を製品に組み込んでから、その製品をカタログに公開することによって、アプリケーション開発者がその API を使用できるようになります。詳細については、「製品の操作」および「カタログの操作」を参照してください。