チュートリアル: 既存の SOAP サービスを呼び出す REST API 定義の作成

このチュートリアルでは、既存の SOAP サービスを公開し、そのサービスによって返される XML データを指定の JSON データに変換する方法について説明します。

このチュートリアルについて

このチュートリアルに従って、既存の SOAP サービスの WSDL をインポートして、 API Manager で REST API を作成します。 SOAP 1.1 と SOAP 1.2 の両規格は API Connect でサポートされている。 API が呼び出されると、特定のユーザーの架空の銀行口座の残高を返します。

このチュートリアルでは、以下のレッスンを行います。
  1. REST API 定義のセットアップ
  2. API 定義のテスト

開始前に

注: Sandboxカタログは、 DataPower® API Gateway、または DataPower Gateway (v5 compatible)、あるいはその両方を使用するように設定する必要があります。 カタログの作成と設定を参照してください。

REST API 定義のセットアップ

既存の SOAP サービスを呼び出す REST API をセットアップするには、以下のステップを実行します。

  1. SOAP WSDL ファイル AccountServicing.txt をダウンロードしてください。 このファイルの名前を AccountServicing.wsdl に変更します。
  2. API Manager UIにログインします。
  3. 「API および製品の開発」タイルをクリックします。

    APIマネージャー画面

  4. Add > API(REST、 GraphQL、またはSOAPから)をクリックします。

    API追加メニュー

  5. 「OpenAPI 2.0」が選択されていることを確認します。
  6. 「既存の WSDL サービスから (REST プロキシー)」を選択します。 「次へ」をクリックします。

    RESTプロキシの作成

  7. 「ファイル・アップロード」セクションで、AccountServicing.wsdl ファイルをドラッグ・アンド・ドロップまたはクリックして、ファイル・システムからそのファイルをアップロードします。

    WSDL確認画面

  8. ファイルがアップロードされ、 API Connect によって解析される。 確認メッセージが表示されます。 「次へ」 をクリックして先に進みます。
  9. を選択します。 AccountServicing WSDLサービスを選択し、 Nextをクリックします。

    WSDLサービス画面

  10. Info セクションの値は変更せずに、 Nextをクリックします。

    API 情報

  11. 「セキュア」セクションで、「キー単位で API 呼び出しを制限する」チェック・ボックスを選択し、「API のアクティブ化」セクションで、「API のアクティブ化」チェック・ボックスを選択します。 「次へ」をクリックします。

    APIのセキュリティと公開

  12. 「要約」画面が表示され、新規 API の作成と公開のステップが表示されます。 このプロセスが完了すると、結果の要約 (API 基本エンドポイントや、新規 API に自動的にサブスクライブするサンドボックス・テスト・アプリケーションの資格情報など) が表示されます。

    結果概要(上)

  13. Edit APIをクリックする。 新規 API がオンラインになります。

    デザインページ(トップ)

既存の SOAP サービスを呼び出す REST API が正常に作成され、テストの準備ができている製品およびプランに組み込まれました。 WSDL ファイルにより、API の入力および応答を構成するために必要なすべての情報が指定されました。

API 定義のテスト

注: Cross-Origin Resource Sharing (CORS) の制限により、アセンブリテストツールは、 macOS Catalina プラットフォームの Chrome または Safari ブラウザでは使用できません。

API Manager テストツールを使用してAPI定義をテストするには、以下の手順を実行します。

  1. AccountServicing APIの Assemble タブをクリックして Assemble ビューに移動し、 Test アイコンをクリックします。 テストのアイコン

    アセンブル・ビュー

    テスト・パネルは現時点で非推奨であり、将来のリリースで「テスト」タブに移動される予定です。

  2. 「テスト」パネルが開き、テスト・セットアップに必要なデフォルトの製品およびプランがリストされます。

    テストペイン

  3. Operation セクションで、呼び出すポスト /getBalance 操作を選択する。

    select 操作

  4. 「テスト」パネルで「要求」フィールドまでスクロールダウンし、「生成」をクリックして、サンプル要求を自動生成します。

    リクエストの作成

  5. InvokeをクリックしてAPIをテストする。 「応答」セクションに API 応答が表示されます。 証明書が信頼されていないことを示すメッセージが表示された場合は、示されたリンクをクリックして証明書を受け入れてから、テスト環境に戻り、再度「呼び出し」をクリックします。

    呼び出し成功

    「応答」セクションに口座の残高が正常に返されます。

このチュートリアルで実行したこと

このチュートリアルでは、以下のアクティビティーを実行しました。

  • REST API 定義をセットアップしました。
  • 既存の Web サービスを呼び出して出力を返すように、SOAP WSDL ファイルに基づいて API を構成しました
  • API 定義をテストしました。