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 検証に適切な証明書を使用します。

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

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

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

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

1. Azure portalで、API 管理サービス

   

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

   

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

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

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

OData メタデータ

OData メタデータをインポートする

1. サイドバー メニューでAPI>API を選択し、次に+ API の追加 を選択します。

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

   

3. API 設定を入力します。 API の [設定] タブに移動することで、後で設定を更新することができます。

   1. OData 仕様で、OData メタデータ エンドポイントの URL を入力します。 通常、この値はサービス ルートの URL であり、 /$metadataが追加されます。 または、インポートするローカルの OData XML ファイルを選択します。

   2. API を構成するための追加の設定を入力します。 設定については、「最初の API のインポートと発行」のチュートリアルで説明されています。

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

   API が API の一覧に追加されます。 OData メタデータ説明の中で公開されているエンティティ セットと関数が、API の [Entity sets and functions] タブ上に表示されます。

   

OData スキーマを更新する

ポータルでエディターにアクセスして、API の OData スキーマを表示できます。 API が変更された場合は、ファイルまたは OData サービス エンドポイントから API Management のスキーマを更新することもできます。

1. サイドバー メニューの >APIs を選択し、OData API を選択します。

2. [ エンティティ セットと関数 ] タブで、エンティティ セットまたは関数の横にある省略記号 (...) を選択し、[ 編集] を選択します。

   

3. スキーマを確認します。 更新する場合は、[ファイルから更新する] または [エンドポイントからスキーマを更新する] を選択します。

   

OData API をテストする

1. サイドバー メニューの >APIs を選択し、OData API を選択します。

2. [ エンティティ セットと関数 ] タブで、エンティティ セットまたは関数の横にある省略記号 (...) を選択し、[ テスト] を選択します。

   

3. テスト コンソールで、テストのテンプレート パラメーター、クエリ パラメーター、ヘッダーを入力し、[ テスト] を選択します。 ポータルでの API のテストの詳細については、ポータルでの 新しい API のテストを参照してください。

OData API をセキュリティで保護する

OData API 要求を通じて攻撃から保護するために、既存の 認証と承認ポリシー と OData 検証ポリシー を適用して、OData API をセキュリティで保護します。

ヒント

ポータルの [API ポリシー] タブで、OData API のポリシーを 構成します。

OpenAPI の仕様

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

1. メタデータ XML に応じて、OData v2 または OData v4 用の OASIS オープンソース ツールを使用します。

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

   odata-openapi -p --basePath '/sap/opu/odata/sap/epm_ref_apps_prod_man_srv' \
    --scheme https --host <your IP address>:<your SSL port> \
    ./epm_ref_apps_prod_man_srv.xml
   

   注

   • 1 つの XML ファイルを使用してテストする場合は、オープンソース ツールに基づく Web ベースのコンバーター を使用できます。
   • ツールまたは Web ベースのコンバーターを使用して、SAP OData サーバーの <IP アドレス> : <ポート> を指定できます (省略可能)。 または、生成された OpenAPI 仕様の後で、またはファイルを API Management にインポートした後に、この情報を追加します。

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

OpenAPI 仕様のインポート

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

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

   

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

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

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

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

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

注

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

API 構成を完了する

インポートした API に次の 3 つの操作を追加します。 方法については、「操作の 追加とテスト」を参照してください。

• GET /$metadata

  操作	説明	操作の追加構成
  GET /$metadata	API Management が $metadata エンドポイントに到達できるようにします。これは、OData サーバーとクライアントを統合するために必要です。 この必須の操作は、生成してインポートした OpenAPI 仕様に含まれていません。	200 OK 応答を追加します。

  

• HEAD /

  操作	説明
  HEAD /	必要に応じて、クライアントがクロスサイト リクエスト フォージェリ (CSRF) トークンを SAP サーバーと交換できるようにします。 SAP では、GET 動詞を介した CSRF トークン交換も許可されます。 CSRF トークンの交換については、この記事では説明しません。 ブローカー トークン交換に関する example API Management ポリシー スニペットを参照してください。

  

• GET /

  操作	説明	操作の追加構成
  GET /	サービス ルートでポリシー構成を有効にします。	サービス ルートに転送される要求に末尾のスラッシュを追加するには、次の受信 書き換え URI ポリシーを構成します。 <rewrite-uri template="/" copy-unmatched-params="true" /> このポリシーは、末尾のスラッシュの有無によって発生する可能性のあるあいまいさを解消します。 これら 2 種類の要求は、一部のバックエンドによって異なる方法で処理されます。

  

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

API のテスト

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

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

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

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

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

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

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

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

実稼働に関する考慮事項

• API Management と SAP ゲートウェイを統合するための エンド ツー エンドシナリオの例 を参照してください。
• API Management ポリシーを使用して SAP バックエンドへのアクセスを制御します。 たとえば、API が OData API としてインポートされる場合は、OData 要求を検証するポリシーを使用します。 SAP ECC または S/4HANA 向けのプリンシパル伝播または SAP SuccessFactors および X-CSRF トークンのフェッチ向けのポリシー スニペットもあります。
• 大規模な API のデプロイ、管理、移行に関するガイダンスについては、次を参照してください。
  • APIOps による自動化された API デプロイメント
  • DevOps と CI/CD を使用して API を発行する

関連コンテンツ

• API のインポートの制限事項
• OpenAPI 仕様のインポート
• SOAP API のインポート
• SOAP API をインポートして REST に変換する
• App Service API をインポートする
• コンテナー アプリ API をインポートする
• Websocket API のインポート
• GraphQL API のインポート
• GraphQL スキーマをインポートし、フィールド リゾルバーを設定する
• 関数アプリ API をインポートする
• ロジック アプリ API をインポートする
• Service Fabric サービスをインポートする
• Microsoft Foundry API をインポートする
• Azure OpenAI API
• LLM API をインポートする
• OData API をインポートする
• REST API を MCP サーバーとしてエクスポートする
• 既存の MCP サーバーを公開する
• A2A エージェント API をインポートする
• SAP OData メタデータをインポートする
• gRPC API をインポートする
• API の編集