SAP OData メタデータを API としてインポートする

適用対象: すべての API Management レベル

この記事では、OData メタデータを使用して OData (Open Data Protocol) サービスを Azure API Management にインポートする方法について説明します。 次の例では、 SAP Gateway Foundation を使用します。

この記事では、次の方法について説明します。

  • SAP サービスから OData メタデータを取得する
  • OData メタデータを直接、または OpenAPI 仕様に変換した後に、Azure API Managementにインポートする
  • API の構成を完了する
  • Azure ポータルで API をテストする

前提条件

  • API Management インスタンスを作成します。

  • OData v2 または v4 として公開されている SAP システムとサービス。

  • SAP バックエンドで自己署名証明書 (テスト用) を使用している場合は、SSL の信頼チェーンの検証を無効にする必要がある場合があります。 これを行うには、API Management インスタンスでバックエンドを構成します。

    1. Azure portal の API で、 バックエンド>+ 新しいバックエンドの作成を選択します。
    2. SAP バックエンド サービスを指す カスタム URL を 追加します。
    3. [ 詳細設定 ] セクションを展開し、[ 証明書チェーンの検証 ] チェック ボックスと [証明書名の検証 ] チェック ボックスをオフにします。

    注

    運用環境のシナリオでは、エンド ツー エンドの SSL 検証に適切な証明書を使用します。

    ヒント

    API Management の完全な機能スコープについては、登録する前に SAP OData API を OpenAPI 仕様に変換します。

SAP サービスから OData メタデータを取得する

SAP サービスからメタデータ XML を取得するには、次のいずれかの方法を使用します。 メタデータ XML を OpenAPI 仕様に変換する場合は、ファイルをローカルに保存します。

  • SAP ゲートウェイ クライアント (トランザクション /IWFND/GW_CLIENT) を使用します。
  • XML: http://<OData server URL>:<port>/<path>/$metadataを取得する直接 HTTP 呼び出しを行います。
  • 該当する場合 は、SAP Business Accelerator Hub を使用します。

API Management インスタンスに移動します。

  1. Azure portal で、API Management サービスを検索して選択します。

    検索結果に API Management サービスを示すスクリーンショット。

  2. [API Management サービス] ページで、API Management インスタンスを選択します。

    [API Management サービス] ページの API Management インスタンスを示すスクリーンショット。

API を API Management にインポートする

API を API Management にインポートするには、次のいずれかの方法を選択します。

  • メタデータ XML を OpenAPI 仕様に変換します (推奨)。
  • メタデータ XML を OData API として直接インポートします。

OData メタデータを OpenAPI JSON に変換する

  1. OASIS オープンソース ツールの上に構築された Microsoft コンバーターを使用します。

    次の例では、テスト サービスの OData v2 XML を epm_ref_apps_prod_man_srv変換します。

    oasis-converter convert epm_ref_apps_prod_man_srv.xml api.json

    注

    1 つの XML ファイルでテストする場合は、 Web ベースのエクスペリエンスを使用できます。

  2. API Management にインポートするために 、openapi-spec.json ファイルをローカルに保存します。

OpenAPI 仕様のインポート

  1. サイドバー メニューの [API ] セクションで、[API] を選択 します。

  2. [ 定義から作成] で、 OpenAPI タイルを選択します。

    OpenAPI タイルを示すスクリーンショット。

  3. [ ファイルの選択] を選択し、前の手順でローカルに保存した openapi-spec.json ファイルを選択します。

  4. API 設定を入力します。 これらの値は、API をインポートするときに設定することも、後で [設定] タブに移動して構成することもできます。

    • API URL サフィックスの場合は、元の SAP サービスと同じ URL パスを使用することをお勧めします。

    • API 設定の詳細については、「最初の API のインポートと発行」のチュートリアルを参照してください。

  5. を選択してを作成します。

また、環境に適した方法を使用して、バックエンドへの認証を構成する必要もあります。 例については、「 認証と承認」を参照してください。

注

API インポートの制限事項については、 API インポートの制限事項と既知の問題に関する説明を参照してください。

API のテスト

  1. API Management インスタンスに移動します。

  2. サイドバー メニューで、[API] を選択します。

  3. [すべての API] で、インポートした API を選択します。

  4. [テスト] タブを選択して、テスト コンソールにアクセスします。

  5. 操作を選択し、必要な値を入力して、[ 送信] を選択します。

    たとえば、 GET /$metadata 呼び出しをテストして、SAP バックエンドへの接続を確認します。

  6. 応答を表示します。 トラブルシューティングを行うには、呼び出しをトレースします。

  7. テストが完了したら、テスト コンソールを終了します。

実稼働に関する考慮事項

関連コンテンツ

  • Last updated on