将 SAP OData 元数据作为 API 导入
适用于:所有 API 管理层级
本文介绍如何使用元数据描述导入 OData 服务。 本文以 SAP Gateway Foundation 为例。
在本文中,你将:
- 从 SAP 服务检索 OData 元数据
- 直接将 OData 元数据导入到 API 管理,或者在转换为 OpenAPI 规范后再导入
- 完成 API 配置
- 在 Azure 门户中测试 API
先决条件
现有的 API 管理实例。 如果还没有实例,请创建一个。
公开为 OData v2 或 v4 的 SAP 系统和服务。
如果你的 SAP 后端使用自签名证书(用于测试目的),你可能需要禁用 SSL 的信任链验证。 为此,请在你的 API 管理实例中配置一个后端:
- 在 Azure 门户中的“API”下面,选择“后端”>“+ 添加”。
- 添加指向 SAP 后端服务的自定义 URL。
- 取消选中“验证证书链”和“验证证书名称”。
注意
对于生产方案,请使用适当的证书进行端到端 SSL 验证。
从 SAP 服务检索 OData 元数据
使用以下方法之一从 SAP 服务检索元数据 XML。 如果计划将元数据 XML 转换为 OpenAPI 规范,请在本地保存文件。
- 使用 SAP 网关客户端(事务
/IWFND/GW_CLIENT
),或 - 进行直接 HTTP 调用以检索 XML:
http://<OData server URL>:<port>/<path>/$metadata
转到你的 API 管理实例
在 Azure 门户中搜索并选择“API 管理服务” 。
在“API 管理”服务页上,选择你的 API 管理实例。
将 API 导入 API 管理
选择以下方法之一将 API 导入到 API 管理:将元数据 XML 作为 OData API 直接导入,或者将元数据 XML 转换为 OpenAPI 规范。
导入 OData 元数据
在左侧菜单中,选择“API”>“+ 添加 API”。
在“根据定义创建”下,选择“OData”。
输入 API 设置。 稍后可以转到 API 的“设置”选项卡来更新设置。
在 OData 规范中,输入 OData 元数据终结点的 URL,通常是服务根的 URL,并附加
/$metadata
。 或者,选择要导入的本地 OData XML 文件。输入其余设置以配置 API。 在导入和发布第一个 API 教程中对这些设置进行了说明。
选择“创建”。
API 将添加到 API 列表中。 OData 元数据说明中公开的实体集和函数显示在 API 的“架构”选项卡上。
更新 OData 架构
可以在门户中访问编辑器以查看 API 的 OData 架构。 如果 API 发生更改,还可以从文件或 OData 服务终结点更新 API 管理中的架构。
在门户中导航到 API 管理实例。
在左侧菜单中,选择 OData API 的“API”>。
在“架构”选项卡上,选择“编辑 (</>)”图标。
查看架构。 如果要更新它,请选择“从文件更新”或“从终结点更新架构”。
保护 OData API
通过应用现有访问控制策略和 OData 验证策略来保护 OData API,以防止通过 OData API 请求的攻击。
提示
在门户中,在“API 策略”选项卡上为 OData API 配置策略。
生产注意事项
- 请参阅端到端方案示例,以将 API 管理与 SAP 网关集成。
- 使用 API 管理策略控制对 SAP 后端的访问。 例如,如果 API 作为 OData API 导入,请使用验证 OData 请求策略。 另请参阅 SAP 主体传播和获取 X-CSRF 令牌的策略片段。