既存の WSDL サービスからの REST プロキシー API の作成

WSDL ファイルに SOAP サービスが定義されている場合は、 WSDL ファイルを使用して、その SOAP サービスを呼び出す API Connect REST プロキシー API を作成できます。

このタスクについて

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

Draft comment: gb042610
Marking all content that relates to importing from a URL as Future, as this option has been deferred: https://github.ibm.com/velox/ui/issues/5878 JenD Mar2018

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

WSDL ファイルが外部依存関係のないスタンドアロン・ファイルである場合は、ディレクトリーから .wsdl ファイルをロードして REST API 定義を作成できます。

WSDL ファイルが他の WSDL ファイルを参照する場合、または XML スキーマ定義を含む XSD ファイルを参照する場合は、 WSDL ファイルとその従属文書の .zip アーカイブを作成してから、ディレクトリーから .zip ファイルをロードして REST API 定義を追加する必要があります。

手順

WSDL ファイルをロードして REST API 定義を追加するには、以下のステップを実行します。
  1. ナビゲーション ペインで [開発] API UI ナビゲーション・ペインの「開発」アイコン をクリックし、 [追加] > [API] をクリックします。
    「API タイプの選択」画面が表示されます。
  2. OpenAPI 」を選択し、 2.0 を選択します。
  3. 「API の追加」ペインで、 「既存の WSDL サービス (REST プロキシー) から」を選択します。 「次へ」をクリックします。
    「既存の WSDL サービスからの API の作成 (REST プロキシー)」ウィンドウが開きます。
  4. スタンドアロ .wsdl ンのファイル、 またはWSDL ファイルとその依存ドキュメントを含む .zip ファイルからサービス情報をアップロードするには、ファイルをドラッグ&ドロップするか、参照して使用するファイルを選択してください。
    Draft comment: gb042610
    There is no option to load from URL yet... so marking these choices as future. JenD Mar2018

    ファイルをアップロードすると、WSDL が評価され、その WSDL が有効かどうかを示すメッセージが表示されます。

    .zip ファイルをアップロードする場合は、.zip ファイルにオプション・ファイルを組み込んで追加のディレクティブを指定できます。 詳細については、 「WSDLサービスのインポート時にオプションファイルを使用する」 を参照してください。

  5. 「次へ」をクリックします。 「サービスの選択」パネルで、インポートされたファイルから WSDL サービスを選択します。
  6. 「次へ」をクリックします。 「情報」セクションで API の要約を指定します。 API は、作成後に微調整できます。
    • 「タイトル」には、特殊文字を含めることができます。ただし、ユーザー・インターフェースに簡単に表示できるように短いものにしてください。
    • 「名前」 は自動的に入力されます。 「名前」 フィールドの値は、 デベロッパーズ・ツールキット CLI コマンドで API を識別するために使用される単一のストリングです。 下書きのAPIを管理するためのCLIコマンドについては、 ツールキットのCLIリファレンスドキュメントを参照してください。
    • Version は、API の OpenAPI 定義の info.version プロパティーの値に対応します。 version.release.modification というバージョン番号付け方式 (例えば 1.0.0) が推奨されます。
    • 「基本パス」は API の URL セグメントであり、ホスト名や、パスおよび操作の追加セグメントは含まれません。 基本パスに特殊文字を含めることはできません。また、特殊文字が空の場合でも、 / 文字で開始する必要があります。
    • オプションの「説明」は、API の識別に役立ちます。
  7. 「次へ」をクリックします。 「保護」セクションで、必要な API セキュリティーを構成します。
    • クライアント ID を使用した保護 - このオプションは、アプリケーションがクライアント ID (API キー) を提供する必要がある場合に選択します。 これにより、 X-IBM-Client-Id パラメーターが API の要求ヘッダーに組み込まれます。 このオプションを選択すると、API 呼び出しをキーごと (クライアント ID ごと) に制限するかどうかを選択できます。
      • キー単位で API 呼び出しレートを制限する - このオプションを選択した場合、必要なレート制限を構成する必要があります。 レート制限は、ある期間 (時、分、月、または日) 内に許可されている呼び出し最大数を制御します。 例えば、1 時間当たり 100 回の呼び出しです。
    • CORS - このオプションは、API の CORS (cross-origin resource sharing) サポートを有効にする場合に選択します。 これにより、別のドメインから API にアクセスできるようになります。
      注:
      • CORS サポートは.でのみ利用 DataPower® API Gateway可能です。
      • CORS を有効にした場合、API ゲートウェイは cors プリフロー・ポリシーを実行して、API に対して発行されたすべての CORS 要求を処理します。
      • CORS が有効にされていて、プリフライト要求が受け取られた場合、以下の API アクションのみが実行されます。
        • cors プリフロー・ポリシーは、適切な応答ヘッダーを構成します。
        • 応答ヘッダーが設定されます。
      • プリフライト要求が受け取られると、request.attributes.isCORSPreflight フラグが true に設定されます。
      • すべてのプリフライト要求において、security プリフロー・ポリシーと client-identification プリフロー・ポリシーは、CORS が有効にされているかどうかに関係なく、常にスキップされます。
  8. オプション: 今後の開発やテストですぐに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 権限を持つ役割が割り当てられている必要があります。 事前に提供されている開発者のロールには、デフォルトでこれらの許可があります。カスタム・ロールが割り当てられている場合は、これらの許可が必要です。 詳しくは、 カスタム・ロールの作成を参照してください。
  9. API 定義を作成するには、 「次へ」 をクリックします。

    「要約」パネルに、定義が作成されたことを示すメッセージが表示され、選択されたセキュリティー・オプションおよびレート制限が適用されます。

    ActivateAPIを選択した場合、ウィザードはテストで使用できるAPIエンドポイント URLを入力します。 「クライアント ID を使用した保護」も選択した場合は、ウィザードに、使用できるクライアント ID およびクライアント秘密鍵が表示されます。

  10. 次のオプションのいずれかを選択します:
    • API をさらに構成するには、「API の編集」をクリックします。 詳しくは、 API 定義の編集を参照してください。
    • この時点では API をこれ以上構成しない場合は、パンくずリスト内の「開発」リンクをクリックしてウェルカム・ページに戻ります。その後、すぐに別のタスクに進むことができます。 後で API を構成する方法について詳しくは、 API 定義の編集を参照してください。

結果

既存の WSDL ファイルを使用して REST API 定義を作成しました。

次のタスク

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

また、 API Designer UIの 「管理 API Designer UI ナビゲーション・ペインの「管理」アイコン 」ページで、APIに関連付けられたサンドボックスカタログを開くことで、製品のライフサイクルを管理したり、製品を閲覧・購読できるユーザーを制御したりすることもできます。