OpenAPI 是什么?为什么应使用它?

已完成

OpenAPI 定义 Web API 的标准接口描述和编程语言无关接口描述。 它使人类和计算机可以发现和了解服务的功能,而无需访问源代码、其他文档或检查网络流量。

OpenAPI 的屏幕截图。

通过使用描述 Web API 的 OpenAPI 文档,用户可以轻而易举地了解 Web API 并与之通信。

只要 OpenAPI 文档正确描述 Web API,就可以为任何 Web API 创建自定义连接器。 也就是说,VanArsdel 的融合开发团队不仅限于根据 Azure API 管理中托管的 Web API 为其 Power Apps 应用程序创建自定义连接器。

OpenAPI 文档有什么作用?

OpenAPI 文档指定 Web API 的公开区域协定。 它根据 API 的使用者将实际实现规范抽象化。 因此,只要您知道要调用的方法及其返回的内容,就可以快速生成应用程序,而不必担心如何调用这些方法。

在上一单元中,您已使用 Azure API 管理创建了自定义连接器。 这样一来,您还创建了对 Azure API 管理的依赖。 换言之,如果 Azure API 管理发生任何更改,则必须更新自定义连接器以反映相应的更改。

使用 OpenAPI 文档,您不必知道 API 位于何处或是否正在运行,因为该文档包含所需的所有信息。

Power Apps 使您可以立即使用本 OpenAPI 文档创建自定义连接器。

多种创建自定义连接器方式的屏幕截图。

根据 OpenAPI 文档创建自定义连接器后,该连接器将显示在 Power Apps 页面中。

Power Apps 页面中自定义连接器的屏幕截图。

为什么应将 OpenAPI 文档用于自定义连接器?

使用 OpenAPI 文档来创建自定义连接器可带来许多好处。 但以下两个好处对平民开发者来说最为关键。

  • 消除依赖关系:使用 OpenAPI 文档,您可以自己创建自定义连接器,而无需等待某人从 API 管理中为您创建自定义连接器。 此外,专业开发团队将 OpenAPI 文档生成功能包括在 Web API 本身中的情况变得越来越常见。 这意味着您可以通过访问 URL 来下载 OpenAPI 文档,然后使用该文档来创建自定义连接器。
  • 提高敏捷性:如果 Web API 开发团队能够向您提供 OpenAPI 文档,则 Power App 开发节奏会加快。 您无需依赖开发团队执行任何其他操作即可创建和使用自定义连接器。

如下图所示,只要合同保持不变,OpenAPI 文档就不必了解 Web API 的实际实现。

无需了解 Web API 的 OpenAPI 示意图。

使用 OpenAPI 文档或 Azure API 管理创建的自定义连接器

要创建自定义连接器,可以使用 Azure API 管理或 OpenAPI 文档。 应选择哪种方法?

下表列出了使用 Azure API 管理和 OpenAPI 文档来创建自定义连接器的一些比较。

连接器 Azure API 管理 OpenAPI 文档
API 控件 集中式 分散式
API 结构层 复杂 简单
额外安全层
使用控制
额外成本
体系结构复杂性 更高 更低