你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

从 Azure 逻辑应用中的工作流调用自己的 Web API 和 REST API

适用于:Azure 逻辑应用(消耗型 + 标准型)

如果已有要从 Azure 逻辑应用中的工作流调用的 Web API 或 REST API,必须先完成一些设置步骤,然后才能调用这些 API。 主要是,必须将 API 部署为 Web 应用或 API 应用。 可以通过在 Azure 应用服务(一个提供高度可缩放、易于 API 托管的云平台)上托管 API 来执行此任务。

在应用服务中,您可以将 API 部署为 Web 应用,但更建议将 API 部署为 API 应用。 在云和本地环境中生成、托管和使用 API 时,此方法可简化作业。 无需更改 API 中的任何代码即可部署到 API 应用。

可以从工作流调用任何 API,但为了获得最佳体验,请将 Swagger 元数据 添加到 Web 应用或 API 应用。 此 Swagger 文档描述了您的 API 操作和参数,帮助逻辑应用工作流更好、更轻松地与您的 API 协作。 还必须在 Web 应用或 API 应用上设置跨域资源共享(CORS),以便工作流可以访问 API。

本指南介绍如何添加 Swagger 文档、为 Web 应用或 API 应用设置 CORS,并提供在应用服务中为 API 完成部署和托管后从工作流调用 API 的选项。

有关详细信息,请参见:

先决条件

向 Web 应用或 API 应用添加 Swagger 和 CORS 访问权限

将 Swagger 文档添加到 Web 应用或 API 应用时,Azure 逻辑应用中的工作流设计器可以更轻松地在 API 中查找和显示可用的作和参数。 还必须在 Web 应用或 API 应用上设置跨域资源共享(CORS),以便工作流可以访问 API。

若要使 Swagger 文档可从设计器中的工作流中读取,请在 Web 应用或 API 应用上设置 API 定义属性和 CORS 访问权限。

  1. Azure 门户中,查找并打开 Web 应用或 API 应用资源。

  2. 在应用资源边栏上,选择“ 概述”。

  3. 在“ 属性 ”选项卡上的“ ”下,从 “默认域 ”属性复制并保存网站名称以供下一步使用。

  4. 在应用资源边栏的 API 下,选择 API 定义。 对于 API 定义位置,请输入 Swagger JSON 文件的 URL,该文件通常使用以下格式,但如果 Swagger 文件使用较新的 API 规范,则可能会有所不同:

    https://<website-name>/swagger/docs/v1

    以下示例显示了具有较新的 API 规范的 Swagger URL:

    屏幕截图显示了 Azure 门户、Web 应用的 API 定义页和 API Swagger 文档的 URL。

  5. 完成后,选择“保存”。

  6. 在应用资源边栏的 API 下,选择 CORS

  7. 对于 “允许的源”,请将 CORS 策略设置为 “*”,这意味着允许所有。

    此设置允许来自 Azure 逻辑应用中工作流设计器的请求。

    屏幕截图显示了 Web 应用的 CORS 窗格,其中“允许源”设置为 *,允许全部。

  8. 在工具栏上选择“保存”。

有关详细信息,请参阅 在 Azure 应用服务中使用 CORS 托管 RESTful API

从工作流调用 API

设置 API 定义 URL 和 CORS 后,API 操作会显示在连接器画廊中,以便找到并添加到工作流中。

  • 若要查看具有 OpenAPI URL 的网站,可以在工作流设计器中浏览订阅网站。

  • 若要通过指向 Swagger 文档查看可用操作和输入,请使用 HTTP + Swagger 触发器或操作。

  • 若要调用任何 API(包括没有或公开 Swagger 文档的 API),始终可以使用 HTTP 操作 来创建请求。