构建 API 代理

学习目标

  • 基于 API provider 创建 API。

基于 API Provider 创建 API 代理

在本课中,我们将涵盖以下主题:

  • 创建 API Proxy 有哪些可能方式?

  • 使用 Create 按钮创建 API Proxy。

  • 使用 Menu 链接创建 API Proxy。

创建 API Proxy 有哪些可能方式?

创建 API Proxy 对于后续实现非常重要。

以下是创建 API Proxy 可用的选项:

使用 Create 按钮创建 API Proxy,包含以下选项:

  • API provider(在组件图中标记为 1)

  • URL(在组件图中标记为 3)

  • API proxy

使用菜单链接创建 API Proxy,包含以下选项:

  • 在 API Designer 中创建(在组件图中标记为 2)

  • 导入外部 API Proxy

CLD900_20_U3L4_001 CLD900_20_U3L4_002

使用 Create 按钮创建 API Proxy

这可能是最常见的情况。使用此选项,你可以借助 API provider、提供的 URL 或现有 API Proxy 来创建 API Proxy。

过程

从 Design→APIs 开始,打开 Develop 界面。

通过选择 Create 按钮启动向导。此时会打开一个新窗口。

CLD900_U3_L4_02

使用 API Provider 选项。

CLD900_20_U3L4_005

选择 API Provider 单选按钮并打开所选的下拉框。将显示所有 API provider。选择一个,例如 SAPGatewayDemoSystemES5_Provider。

CLD900_20_U3L4_006_scr

选择 API Provider 后,会出现一个名为 Discover 的新列表框。部分数据,例如 host 和 API 类型,已经填写好了。

选择该列表框后,将显示目录服务中列出的所有可用服务。

这里具体显示什么取决于 API Provider 的类型。例如,对于 Open Connectors,会显示所有实例。对于 Cloud Integration 类型,则显示可用的集成流。

下图显示了可从 SAP 后端系统使用的服务列表。通过从提供的服务目录中选择一个服务来定义 API provider。

CLD900_20_U3L4_007_scr

你只能从提供的服务中恰好选择一个服务。之后,更多数据会被添加到该界面中。

CLD900_20_U3L4_008_scr

完成此 API proxy 的创建后,必须将其部署才能使用。之后,该 API proxy 即可用于测试。service type 会被自动定义。在本例中为 OData。

使用 URL 选项创建 API Proxy

如果不使用 API provider,你可以直接指定源的 URL。

CLD900_20_U3L4_009

在这种情况下,你需要手动输入数据。Service Type 只能是 REST 或 SOAP。

CLD900_20_U3L4_010_scr

保存并部署 API Proxy 后,同样可以对其进行测试。

使用 API Proxy 选项创建 API

在这种情况下,你可以复制现有的 API proxy。

CLD900_20_U3L4_011_scr

在这种情况下,你需要手动输入数据。即使被复制的 API proxy 属于 OData 类型,Service Type 也只能是 REST 或 SOAP。

使用菜单链接创建 API Proxy

CLD900_20_U3L4_012

使用 Create in API Designer 选项

通过选择菜单链接 Create in API Designer 开始创建 API Proxy。

CLD900_20_U3L4_013_scr

切换到 openAPI 编辑器。你可以在编辑器中通过 YAML 语言的 openAPI 手动创建 API Proxy。在这种情况下,所有条目都必须手动创建。保存后服务器 URL 会自动调整。Service Type 只能是 REST。

保存前

CLD900_20_U3L4_014_scr

保存后

注意

显示的 URL 是示例,无法使用。

CLD900_20_U3L4_015_scr

导入外部 API Proxy

CLD900_20_U3L4_016

通过选择菜单链接 Import API proxy 开始创建 API proxy。

CLD900_20_U3L4_017_scr

Service Type 与导入的 API proxy 相对应。

资源

Help Portal:创建 API Proxy

小结

创建 API proxy 有多种方式。API proxy 可以:

  • 通过 Create 按钮创建。

  • 基于现有 API provider 创建。

  • 通过提供的 URL 直接创建。

最后,你也可以在 API Designer 中通过 Create 按钮使用 openAPI 规范来定义它。

基于预定义的 API Provider 创建 API Proxy

业务场景

在本练习中,你将学习在 API Management 中建立绿色标示的 API provider 与我们正在开发的新 API proxy 之间的连接。由此产生的后续连接及相关工件在组件图中以红色标示。

CLD900_U3_L4_01

任务流

在本练习中,你将执行以下任务:

  1. 创建 API proxy。

  2. 测试 API proxy。

前提条件

你已成功完成前面的练习。

练习成果

你拥有一个基于 S/4HANA on-premise 系统的 API provider 的可正常工作的 API。这允许从 S/4HANA on-premise 系统调用 API。

你将从这个练习中学到什么?

你可以基于 API provider 创建并配置 API proxy。这使你能够调用 S/4HANA on-premise 后端系统上的 GWSAMPLE_BASIC OData 接口。

练习:开始练习(SAP 官方交互式练习)