编辑 API

学习目标

• 编辑 API。

编辑 API

本课将涵盖以下主题：

• 探索 View API 视图。

• 探索 通知 区域。

• 探索 API URL - 代理 URL。

• 探索 导航 选项卡。

• 从 API Designer 创建或编辑 API。

探索 API 视图

创建并部署 API 后，该 API 会显示在 API 视图中。以下是 GWSAMPLE_BASIC API 的示例。

我们将在后续章节中详细讨论以下标记区域：

• 1：API URL - 代理 URL

• 2：导航选项卡

• 3：通知区域

探索通知区域（标记为 3）

在右侧面板中，您可以找到 API 运行状况、已发起的活动调用以及有关该 API 的相关使用信息。

由于我们尚未使用此 API，因此没有可用的使用信息。

API URL - 代理 URL（标记为 1）

在这里，您可以看到新的 URL（代理 URL），您现在可以使用它来调用原始源 API。该 URL 由以下元素组成：

• API URL：https://group-cld900-d052537.prod01.apimanagement.eu10.hana.ondemand.com:443/GWSAMPLE_BASIC

• 应用协议：https

• 虚拟主机：group-cld900-d052537

• API 主机：prod01.apimanagement.eu10.hana.ondemand.com

• API 端口：443

• API 名称：GWSAMPLE_BASIC

虚拟主机

虚拟主机是在配置 API Management 期间创建的，可随时使用 Settings→APIs 进行更改。检查并查看您的主机别名。

API 主机

API 主机取决于您的子账户。它也可以是您自己的自定义域名。

导航选项卡（标记为 2）

共有五个选项卡，名称如下：

• 概览

• 代理端点

• 目标端点

• 资源

• 修订版本

选项卡 1：概览

在此 Overview 选项卡中，您将找到有关 API 的所有主要信息。

具体如下：

• 标题

• 主机别名，即本页顶部 Proxy URL 中的主机

• API 基础路径

• API 状态（Active、Alpha、Beta、Deprecated、Decommissioned）

• 描述

在界面底部，有一个

产品关联

区域。稍后，我们将基于该 API 创建一个产品。每个条目都可以更改。

选项卡 2：代理端点

在这里，您可以添加一些代理端点属性和路由规则。在此处阅读更多内容：API Proxy Structure

选项卡 3：目标端点

在这里，您可以找到已配置的

API 提供者

或 URL。在本例中，我们看到

SAPGatewayDemoSystemES5_Provider

。也可以使用

负载均衡

。

选项卡 4：资源

这是 API 最重要的区域。它通过 Swagger UI 显示所有可能的资源路径和 REST 操作（GET、PUT、DELETE..）以及所有必要的参数。

下图给出了一个资源路径示例 /ProductSet，以及带有预定义查询参数的 REST 操作 GET。

此选项卡中的这些条目从何而来？

在为 SOAP 和 REST 创建 API 时，API 资源不会自动生成；您必须手动添加它们。在为 ODataAPI 创建 API 时，有时可以自动生成资源。如果您使用类型为 On-Premise with SAP backend 的 API 提供者，或来自 Type Open Connectors 的提供者，就属于这种情况。资源的可视化由 Swagger UI 实现完成。它会解析此 API 的 openAPI 规范。

选项卡 5：修订版本

借助 API 修订版本，您可以对 API 代理进行增量更改，而不会中断已部署的 API。您可以访问对 API 代理所做的先前更改，甚至可以将 API 恢复到其任何较早状态。

修订版本通常由小型、增量且兼容的更改组成，例如向 API 代理添加属性、新资源或策略。当更改不会中断现有消费流时，就会创建修订版本。它们与用于消费 API 的实际 URL 无关。由于被消费的是已部署的修订版本，因此无需单独访问它。API 代理 URL 在不同修订版本之间保持一致。

运行时环境中只存在 API 代理的一个修订版本。在设计阶段，您可以查看和比较不同修订版本的内容。

有关创建 API 修订版本的更多信息，请访问 help.sap.com 网站：Creating API Revisions | SAP Help Portal

从 API Designer 创建或编辑 API

由于并非总能自动生成资源，SAP API Management 还为您提供了手动生成资源的能力。资源可视化在 API Designer 中创建的 openAPI 规范。

创建 API 的过程

在 API 的 Configure 视图中，选择链接 Create in API Designer 以打开 API Designer。您将找到一个简单的 YAML 起始模板。

现在您可以开始编写自己的 openAPI 规范。要编辑 openAPI 规范，请使用同一编辑器。您也可以使用其他编辑器，例如 IDE、Visual Code 等，并将结果复制到其中。

资源

您可以在此处找到完整的 openAPI 文档：

• OpenAPI Specification

• Create an API from API Designer

• https://swagger.io/docs/specification/about/

• Help Portal： Edit an API Proxy

概要

代理 URL 是最终用于消费资源 API 的新 URL。虚拟主机名由您定义。它在子账户中用作 API 主机（API 代理 URL）。

代理 URL 是最终用于消费资源 API 的新 URL。虚拟主机名由您定义。它在子账户中用作 API 主机（API 代理 URL）。这里也可以是自定义域。SAP API Management 在 View API 中提供了具有不同功能的不同选项卡。Resources 选项卡最为重要。资源描述了 REST 功能（GET、POST 等）以及指向实际数据的路径（/ProductSet、/BusinessPartnerSet...）。该描述基于 openAPI 规范。openAPI 规范的可视化通过 Swagger UI 完成。Swagger UI 是一个开源 JavaScript 框架，用于让 API 变得可触可感。

探索 API Designer

业务场景

通过本练习，您将应用 OpenAPI 格式（一种供应商中立的描述标准），定义新 API 或修改现有 API。以下组件图说明了所生成的连接和产物，灰色阴影部分即表示这些产物。

任务流

在本练习中，您将执行以下任务：

1. 探索 API Designer - 设计先行方法。

2. 探索 API 代理的 openAPI 规范。

前提条件

您可以访问 API Management，其中包含 SAP Integration Suite 中的 API 代理。

如果您没有访问权限，可以观看下面的分步演示。

练习成果

通过 API Designer 工具熟悉 OpenAPI 规范及其实现。

您将从本练习中学到什么？

您将学习如何使用 API Designer 将您的 API 转换到 SAP API Management 中。

Exercise：Start Exercise（SAP 官方交互式练习）

任务 1：探索 API Designer

步骤

1. 探索 API Designer，一种设计先行方法。

2. 导航到 Configure→APIs。

3. 选择您的 API 代理。

4. 选择 Edit→Edit in API Designer 以打开 API Designer。

5. 查看 API Designer。

• No. 1：导入 YAML 或 JSON 格式的 openAPI 规范

• No. 2：下载 YAML 或 JSON 格式的 openAPI 规范

• No. 3：粘贴不同格式（RAML、Data、JSON）

• No. 4：Generate Server Stub 生成不同语言和框架的服务器实现（Node.js、Java -Spring、Java EE）

5. 选择每个菜单项，查看它们如何工作。

6. 探索 API 规范。

7. 编辑器区域以 YAML（Yet Another Markup Language）格式描述 API 的定义。更多信息请参见：https://yaml.org/

8. OpenAPI 是描述基于 REST 的接口的标准。更多信息请参见：https://www.openapis.org/。此处使用的是 OpenAPI Specification 3.0.0（1）。

9. 在此 API 描述中有若干块。其中一个是 API Server（2）。这是 S/4HANA 系统的原始源 API。

10. 路径块描述资源上下文。每个资源上下文都通过 Swagger UI（3）进行可视化。您可以在此处找到更多信息：https://swagger.io/tools/swagger-ui/

本课其余配图