将 SAP OData 元数据作为 API 导入

适用于：所有 API 管理层级

本文介绍如何使用其元数据说明导入 OData 服务。 SAP Gateway Foundation 用作示例。

本文内容：

• 从 SAP 服务检索 OData 元数据
• 将 OData 元数据直接导入 Azure API 管理，或转换为 OpenAPI 规范后再导入。
• 完成 API 配置
• 在 Azure 门户中测试 API

先决条件

• API 管理实例。 如果没有 API 管理实例，请使用 Azure 门户完成 创建 API 管理实例中的步骤。

• 公开为 OData v2 或 v4 的 SAP 系统和服务。

• 如果 SAP 后端使用自签名证书（进行测试），则可能需要禁用 SSL 信任链的验证。 为此，请在你的 API 管理实例中配置一个后端：

  1. 在 Azure 门户中的 APIs 下，选择 Backends>+ 添加。
  2. 添加指向 SAP 后端服务的 自定义 URL 。
  3. 清除 “验证证书链 ”和 “验证证书名称 ”复选框。

  注意

  在生产方案中，使用适当的证书进行端到端 SSL 验证。

从 SAP 服务检索 OData 元数据

使用以下方法之一从 SAP 服务检索元数据 XML。 如果计划将元数据 XML 转换为 OpenAPI 规范，请在本地保存文件。

• 使用 SAP 网关客户端（事务 ）。
  或
• 进行直接 HTTP 调用以检索 XML： 。

转到你的 API 管理实例

1. 在 Azure portal 中，搜索并选择 API 管理服务：

   在搜索结果中显示 API 管理服务的屏幕截图。

2. 在“API 管理服务”页上，选择你的 API 管理实例：

   显示“API 管理服务”页面上的 API 管理实例的屏幕截图。

将 API 导入 API 管理

选择以下方法之一，将 API 导入 API 管理：

• 将元数据 XML 作为 OData API 直接导入。
• 将元数据 XML 转换为 OpenAPI 规范。

导入 OData 元数据

1. 在左侧菜单中，选择 API API，然后选择“+ 添加 API”。

2. 在“从定义创建”下方，选择OData

   显示按照门户中的 OpenAPI 说明创建 API 的屏幕截图。

3. 输入 API 设置。 稍后可以转到 API 的“设置”选项卡来更新设置。

   1. 在 OData 规范中，输入 OData 元数据终结点的 URL。 此值通常是服务根的 URL，后面追加了 。 或者，选择要导入的本地 OData XML 文件。

   2. 输入其他设置来配置 API。 在导入和发布第一个 API 教程中对这些设置进行了说明。

4. 选择“创建”。

   API 将添加到 API 列表中。 OData 元数据说明中公开的实体集和函数会显示在 API 的“实体集和函数”选项卡上。

   显示 OData 实体集和函数的屏幕截图。

更新 OData 架构

可以在门户中访问编辑器以查看 API 的 OData 架构。 如果 API 发生更改，还可以从文件或 OData 服务终结点更新 API 管理中的架构。

1. 在门户中导航到 API 管理实例。

2. 在左侧菜单中，选择 API，然后选择 OData API。

3. 在 “实体集和函数 ”选项卡上，选择实体集或函数旁边的省略号（...），然后选择“ 编辑”。

   显示“编辑”命令位置的屏幕截图。

4. 查看架构 如果要更新它，请选择“从文件更新”或“从终结点更新架构”。

   OData API 的架构编辑器的屏幕截图。

测试 OData API

1. 在左侧菜单中，选择 API，然后选择 OData API。

2. 在 “实体集和函数 ”选项卡上，选择实体集或函数旁边的省略号（...），然后选择“ 测试”。

   显示“测试”命令的屏幕截图。

3. 在测试控制台中，输入测试的模板参数、查询参数和标头，然后选择“ 测试”。 有关门户中测试 API 的详细信息，请参阅 门户中测试新 API。

保护 OData API

通过应用现有的 身份验证和授权策略 和 OData 验证策略来保护 OData API，以防止通过 OData API 请求的攻击。

提示

在门户中，在“API 策略”选项卡上为 OData API 配置策略。

将 OData 元数据转换为 OpenAPI JSON

1. 将 OData XML 转换为 OpenAPI JSON 格式。 根据你的元数据 XML，对 OData v2 或 OData v4 使用 OASIS 开源工具。

   以下示例针对测试服务 转换 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. 将 文件保存在本地以导入 API 管理。

导入 OpenAPI 规范

1. 在左侧导航窗格中的 “API ”部分，选择 API。

2. 在“ 创建新定义”下，选择 “OpenAPI：

   显示 OpenAPI 磁贴的屏幕截图。

3. 单击 “选择文件”，然后选择 在上一步中本地保存的文件。

4. 输入 API 设置。 导入 API 时，可以通过转到 “设置” 选项卡来设置这些值。

   • 对于 API URL 后缀，建议使用与原始 SAP 服务相同的 URL 路径。

   • 有关 API 设置的更多信息，请参阅导入和发布你的第一个 API 教程。

5. 选择“创建”。

注意

有关 API 导入限制的信息，请参阅 API 导入限制和已知问题。

完成 API 配置

将以下三个操作添加到你导入的 API 中：

• GET /$metadata

  操作	说明	操作的其他配置
  GET /$metadata	使 API 管理能够访问 终结点，此终结点是客户端与 OData 服务器集成所必需的。 你生成和导入的 OpenAPI 规范中未包含这一必需操作。	添加 响应。

  显示 GET 元数据操作的屏幕截图。

• HEAD /

  操作	说明
  HEAD /	使客户端能够在需要时与 SAP 服务器交换跨网站请求伪造 (CSRF) 令牌。 SAP 还允许通过 GET 谓词进行 CSRF 令牌交换。 本文不涉及 CSRF 令牌交换。 请参阅 示例 API 管理策略代码片段以进行代理令牌交换。

  屏幕截图显示提取令牌的操作。

• GET /

  操作	说明	操作的其他配置
  GET /	在服务根目录中启用策略配置。	配置以下入站 rewrite-uri 策略以将尾部左斜线附加到转发到服务根的请求： <rewrite-uri template="/" copy-unmatched-params="true" /> 此策略可消除带与不带尾随左斜线的请求之间的潜在歧义。 这些请求的两种类型在某些后端的处理方式上有所不同。

  屏幕截图显示服务根的 GET 操作。

还需要使用适用于环境的相应方法配置对后端的身份验证。 有关示例，请参阅 API 管理身份验证和身份验证策略。

测试 API

1. 导航到 API 管理实例。

2. 在左侧导航窗格中的 “API ”部分，选择 API。

3. 在“所有 API”下，选择导入的 API。

4. 选择“测试”选项卡以访问“测试”控制台。

5. 选择一个操作，输入任何所需的值，然后选择“发送”。

   例如，测试 调用以验证与 SAP 后端的连接。

6. 查看响应 要进行故障排除，请跟踪调用。

7. 完成测试后，退出测试控制台。

生产注意事项

• 请参阅将 API 管理与 SAP 网关集成 的示例端到端方案 。
• 使用 API 管理策略控制对 SAP 后端的访问。 例如，如果 API 作为 OData API 导入，请使用验证 OData 请求策略。 针对 SAP ECC 或 S/4HANA 的 SAP 主体传播、SAP SuccessFactors 和提取 X-CSRF 令牌，也有策略片段。
• 有关大规模部署、管理和迁移 API 的指南，请参阅：
  • 使用 APIOps 进行自动化 API 部署。
  • 用于 API 管理的 CI/CD 使用 Azure 资源管理器 模板。

相关内容

• API 导入限制
• 导入 OpenAPI 规范
• 导入 SOAP API
• 导入 SOAP API 并将其转换为 REST
• 导入应用服务 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