将 SAP OData 元数据作为 API 导入

适用于：所有 API 管理层级

本文介绍如何使用 OData 元数据将 OData（开放数据协议）服务导入Azure API 管理。以下示例使用 SAP Gateway Foundation。

在这篇文章中，你将学会如何：

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

先决条件

创建 API 管理实例。
公开为 OData v2 或 v4 的 SAP 系统和服务。
如果 SAP 后端使用自签名证书（进行测试），则可能需要禁用 SSL 信任链的验证。为此，请在你的 API 管理实例中配置一个后端：
1. 在 Azure 门户中的 APIs 下，选择 Backends>+ 创建新的后端。
2. 添加指向 SAP 后端服务的 自定义 URL 。
3. 展开“ 高级 ”部分，然后清除 “验证证书链 ”和 “验证证书名称 ”复选框。
注意

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

提示

对于 API 管理的完整功能范围，请在注册之前将 SAP OData API 转换为 OpenAPI 规范。

从 SAP 服务检索 OData 元数据

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

使用 SAP 网关客户端（事务 /IWFND/GW_CLIENT）。
进行直接 HTTP 调用以检索 XML： http://<OData server URL>:<port>/<path>/$metadata。
如果适用，请使用 SAP Business Accelerator Hub 。

转到你的 API 管理实例

在 Azure portal 中，搜索并选择 API 管理服务：
在 API 管理服务 页上，选择 API 管理实例：

将 API 导入 API 管理

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

将元数据 XML 转换为 OpenAPI 规范（建议）。
将元数据 XML 作为 OData API 直接导入。

OpenAPI 规范（建议）
OData 元数据

将 OData 元数据转换为 OpenAPI JSON

使用基于 OASIS 开源工具的Microsoft转换器。

以下示例针对测试服务 epm_ref_apps_prod_man_srv 转换 OData v2 XML：
```
oasis-converter convert epm_ref_apps_prod_man_srv.xml api.json
```
注意

若要使用单个 XML 文件进行测试，可以使用基于 Web 的体验。
在本地保存 openapi-spec.json 文件以导入到 API 管理。

导入 OpenAPI 规范

在边栏菜单中的 “API ”部分，选择 API。
在 “从定义创建”下，选择 OpenAPI 磁贴：
选择 “选择文件”，然后选择在上一步中本地保存 的openapi-spec.json 文件。
输入 API 设置。导入 API 时，可以通过转到 “设置” 选项卡来设置这些值。
- 对于 API URL 后缀，建议使用与原始 SAP 服务相同的 URL 路径。
- 有关 API 设置的更多信息，请参阅导入和发布你的第一个 API 教程。
选择“创建”。

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

注意

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

测试 API

导航到 API 管理实例。
在边栏菜单中，选择 API>API。
在“所有 API”下，选择导入的 API。
选择“测试”选项卡以访问“测试”控制台。
选择一个操作，输入任何所需的值，然后选择“发送”。

例如，测试 GET /$metadata 调用以验证与 SAP 后端的连接。
查看响应。故障排除，请跟踪通话。
完成测试后，退出测试控制台。

导入 OData 元数据

在左侧菜单中，选择 API API>，然后选择“+ 添加 API”。
在“从定义创建”下方，选择OData
输入 API 设置。稍后可以转到 API 的“设置”选项卡来更新设置。
1. 在 OData 规范中，输入 OData 元数据终结点的 URL。此值通常是服务根的 URL，后面追加了 /$metadata。或者，选择要导入的本地 OData XML 文件。
2. 输入其他设置来配置 API。在导入和发布第一个 API 教程中对这些设置进行了说明。
选择“创建”。

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

更新 OData 架构

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

在门户中导航到 API 管理实例。
在左侧菜单中，选择 API，然后选择 OData API。
在 “实体集和函数 ”选项卡上，选择实体集或函数旁边的省略号（...），然后选择“ 编辑”。
查看架构。如果要更新它，请选择“从文件更新”或“从终结点更新架构”。

测试 OData API

在左侧菜单中，选择 API，然后选择 OData API。
在 “实体集和函数 ”选项卡上，选择实体集或函数旁边的省略号（...），然后选择“ 测试”。
在测试控制台中，输入测试的模板参数、查询参数和标头，然后选择“ 测试”。有关门户中测试 API 的详细信息，请参阅门户中测试新 API。

保护 OData API

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

提示

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

生产注意事项

请参阅将 API 管理与 SAP 网关集成的示例端到端方案。
使用 API 管理策略控制对 SAP 后端的访问。例如，如果 API 作为 OData API 导入，请使用验证 OData 请求策略。也有关于 SAP ECC 或 S/4HANA 的 SAP 主体传播策略片段，以及 SAP SuccessFactors 和提取 X-CSRF 令牌的策略片段。

Last updated on 2026-05-26