將 SAP OData 中繼資料匯入為 API

適用於：所有 API 管理層級

本文說明如何使用其元數據描述匯入 OData 服務。 SAP Gateway Foundation 會作為範例使用。

本文中您將會：

• 從 SAP 服務擷取 OData 中繼資料
• 將 OData 元數據匯入至 Azure API 管理，無論是直接匯入或是先轉換成 OpenAPI 規格再匯入。
• 完成 API 設定
• 在 Azure 入口網站中測試 API

必要條件

• API 管理執行個體。 如果您沒有帳戶，請使用 Azure 入口網站完成 建立 API 管理實例中的步驟。

• 以 OData v2 或 v4 公開的 SAP 系統和服務。

• 如果您的 SAP 後端使用自我簽署憑證（用於測試），您可能需要停用 SSL 信任鏈結的驗證。 作法是在 API 管理執行個體中設定後端：

  1. 在 Azure 入口網站的 [API] 下，選取 [後端]>[+ 新增]。
  2. 新增指向 SAP 後端服務的 自訂 URL 。
  3. 清除 [ 驗證憑證鏈結 ] 和 [ 驗證憑證名稱 ] 複選框。

  附註

  在生產案例中，使用適當的憑證進行端對端SSL驗證。

從 SAP 服務擷取 OData 中繼資料

使用下列其中一種方法，從 SAP 服務擷取元數據 XML。 如果您打算將中繼資料 XML 轉換成 OpenAPI 規格，請在本機儲存檔案。

• 使用 SAP 閘道用戶端 (交易 /IWFND/GW_CLIENT)。
  或
• 進行直接 HTTP 呼叫以擷取 XML： http://<OData server URL>:<port>/<path>/$metadata。

移至您的 API 管理執行個體

1. 在 Azure 入口 網站中，搜尋並選取 [API 管理服務]：

   

2. 在 [ API 管理服務 ] 頁面上，選取您的 API 管理實例：

   

將 API 匯入至 API 管理

選擇下列其中一種方法，將您的 API 匯入至 API 管理：

• 直接將元數據 XML 匯入為 OData API。
• 將元數據 XML 轉換為 OpenAPI 規格。

OData 中繼資料

匯入 OData 中繼資料

1. 在左側功能表中，選取 [APIs>APIs]，然後選取 [+ 新增 API]。

2. 在 [從定義建立] 下，選取 OData：

   

3. 輸入 API 設定。 您稍後可以移至 API 的 [設定] 索引標籤來更新設定。

   1. 在 OData 規格中，輸入 OData 元數據端點的 URL。 此值通常是服務根目錄的網址，附加於 /$metadata。 或者，選取要匯入的本機 OData XML 檔案。

   2. 輸入其他設定來設定 API。 這些設定會在匯入和發佈您的第一個 API 教學課程中說明。

4. 選取 [建立]。

   API 會新增至 API 清單。 OData 中繼資料描述中公開的實體集和函式，會顯示在 API 的 [實體集和函式] 索引標籤上。

   

更新 OData 結構描述

您可以在入口網站中存取編輯器，以檢視 API 的 OData 結構描述。 如果 API 變更，您也可以從檔案或 OData 服務端點更新 APIM 中的結構描述。

1. 在入口網站中，瀏覽至您的 API 管理執行個體。

2. 在左側功能表中，選取 [API]，然後選取您的 OData API。

3. 在 [ 實體集和函 式] 索引標籤上，選取實體集或函式旁邊的省略號 （...），然後選取 [ 編輯]。

   

4. 檢閱結構描述。 若要更新，請選取 [從檔案更新] 或 [從端點更新結構描述]。

   

測試 OData API

1. 在左側功能表中，選取 [API]，然後選取您的 OData API。

2. 在 [ 實體集和函 式] 索引標籤上，選取實體集或函式旁的省略號 （...），然後選取 [ 測試]。

   

3. 在測試控制台中，輸入測試的範本參數、查詢參數和標頭，然後選取 [ 測試]。 如需在入口網站中測試 API 的詳細資訊，請參閱在入口網站 中測試新的 API。

保護 OData API

套用現有的 驗證和授權原則和OData 驗證原則來保護 OData API，以防止透過 OData API 要求的攻擊。

提示

在入口網站中，於 [API 原則] 索引標籤上設定 OData API 的原則。

OpenAPI 規格

將 OData 中繼資料轉換為 OpenAPI JSON

1. 將 OData XML 轉換為 OpenAPI JSON 格式。 視中繼資料 XML 而定，使用 OData v2 或 OData v4 的 OASIS 開放原始碼工具。

   下列範例會轉換測試服務 epm_ref_apps_prod_man_srv 的 OData v2 XML：

   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
   

   附註

   • 若要使用單一 XML 檔案進行測試，您可以使用以開放原始碼工具為基礎的 Web 型轉換器 。
   • 使用工具或 Web 型轉換器時，可選擇指定 SAP OData 伺服器的 <IP 位址>:<連接埠>。 或者，稍後在產生的OpenAPI規格中新增此資訊，或在您將檔案匯入API管理之後。

2. 將 openapi-spec.json 檔案儲存在本機，以匯入至 API 管理。

匯入 OpenAPI 規格

1. 在左側瀏覽窗格中的 [ API] 區段中，選取 [API]。

2. 在 [建立新定義] 底下，選取 [OpenAPI]：

   

3. 按兩下 [選取檔案]，然後選取 openapi-spec.json 您在上一個步驟中本機儲存的檔案。

4. 輸入 API 設定。 您可以在匯入 API 時設定這些值，或稍後移至 [設定] 索引標籤進行設定。

   • 針對 API URL 後綴，我們建議使用與原始 SAP 服務相同的 URL 路徑。

   • 如需 API 設定的詳細資訊，請參閱匯入和發佈您的第一個 API 教學課程。

5. 選取 [建立]。

附註

如需 API 匯入限制的相關信息，請參閱 API 匯入限制和已知問題。

完成 API 設定

將 下列三項作業新增至您匯入的 API：

• GET /$metadata

  作業	描述	作業的其他組態
  GET /$metadata	使 API 管理能夠連接至 $metadata 端點，此端點對於用戶端與 OData 伺服器的整合是必需的。 您產生和匯入的 OpenAPI 規格未包含此必要作業。	新增 200 OK 回應。

  

• HEAD /

  作業	描述
  HEAD /	讓用戶端在必要時與 SAP 伺服器交換跨網站偽造要求 (CSRF) 權杖。 SAP 也允許透過 GET 動詞命令交換 CSRF 令牌。 本文未涵蓋 CSRF 令牌交換。 請參閱 用於協助令牌交換的 API 管理策略代碼片段範例。

  

• GET /

  作業	描述	作業的其他組態
  GET /	在服務根目錄啟用原則設定。	設定下列輸入 rewrite-uri 原則，在轉送至服務根目錄的要求尾端附加斜線： <rewrite-uri template="/" copy-unmatched-params="true" /> 此原則消除了因要求是否有後置斜線而可能產生的歧異。 這兩種類型的要求會受到某些後端的不同處理。

  

您也需要針對環境使用適當的方法來設定後端的驗證。 如需範例，請參閱 APIM 驗證和授權原則。

測試您的 API

1. 瀏覽至 API 管理執行個體。

2. 在左側瀏覽窗格中的 [ API] 區段中，選取 [API]。

3. 在 [所有 API] 下，選取您匯入的 API。

4. 選取 [測試] 索引標籤以存取測試主控台。

5. 選取作業、輸入任何必要值，然後選取 [ 傳送]。

   例如，測試 GET /$metadata 呼叫以確認 SAP 後端的連線能力。

6. 檢視回應。 若要進行疑難排解，請追蹤呼叫。

7. 當您完成測試時，請結束測試控制台。

生產考量

• 請參閱將 API 管理與 SAP 閘道整合的範例 端對端案例 。
• 使用 API 管理原則控制對 SAP 後端的存取。 例如，如果 API 匯入為 OData API，請使用驗證 OData 要求原則。 此外還有 SAP ECC 或 S/4HANA 的 SAP 主體傳播或 SAP SuccessFactors 和擷取 X-CSRF 權杖的原則程式碼片段。
• 如需大規模部署、管理和移轉 API 的指引，請參閱：
  • 使用 APIOps 進行自動化 API 部署。
  • 在 API 管理中使用 Azure Resource Manager 範本來支援 CI/CD。

相關內容

• API 匯入限制
• 匯入 OpenAPI 規格
• 匯入 SOAP API
• 匯入 SOAP API 並將它轉換成 REST
• 匯入 App Service API
• 匯入容器應用程式 API
• 匯入 WebSocket API
• 匯入 GraphQL API
• 匯入 GraphQL 結構描述並設定欄位解析器
• 匯入函式應用程式 API
• 匯入邏輯應用程式 API
• 匯入 Service Fabric 服務
• 匯入 Azure AI Foundry API
• 匯入 Azure OpenAI API
• 匯入 LLM API
• 匯入 OData API
• 將 REST API 匯出為 MCP 伺服器
• 公開現有的 MCP 伺服器
• Import an A2A agent API
• 匯入 SAP OData 中繼資料
• 匯入 gRPC API
• 編輯 API