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

从 Azure 逻辑应用中的工作流部署和调用自定义 API

适用于:Azure 逻辑应用(消耗)

创建自己的 API 以用于逻辑应用工作流后,需要先部署这些 API,然后才能对其进行调用。 虽然可以将 API 部署为 Web 应用,但请考虑将 API 部署为 API 应用,便于更加轻松地在云端和本地生成、托管和使用 API。 不必更改 API 中的任何代码 - 可直接将代码部署到 API 应用。 可在 Azure App Service 上托管API,它是一款平台即服务 (PaaS) 产品,可提供简单的高缩放性 API 托管。

虽然可从逻辑应用工作流调用任何 API,但为获得最佳体验,请添加 Swagger 元数据,用于说明 API 的操作和参数。 此 Swagger 文档有助于使 API 与逻辑应用工作流集成更轻松、运行更顺畅。

将 API 部署为 Web 应用或 API 应用

若要从逻辑应用工作流调用自定义 API,首先需将 API 作为 Web 应用或 API 应用部署到 Azure 应用服务。 若要使工作流能够读取 Swagger 文档,请为 Web 应用或 API 应用设置 API 定义属性并开启跨域资源共享 (CORS)

  1. Azure 门户中,选择 Web 应用或 API 应用。

  2. 在打开的应用菜单的 API 下方,选择“API 定义”。 将“API 定义位置”设置为你的 swagger.json 文件的 URL。

    通常,URL 的格式为:https://{name}.azurewebsites.net/swagger/docs/v1)

    显示 Azure 门户的屏幕截图,其中 Web 应用的“API 定义”窗格已打开,且“API 定义位置”框设置为关于自定义 API 的 Swagger 文档的 URL。

  3. 在“API”下,选择“CORS”。 将“允许的源”的 CORS 策略设置为 '*' (允许所有)。

    此设置允许来自工作流设计器的请求。

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

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

从逻辑应用工作流调用自定义 API

设置 API 定义属性和 CORS 后,应可将自定义 API 的触发器和操作包含在逻辑应用工作流中。

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

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

  • 无论调用任何 API(包括不具有或未公开 Swagger 文档的 API),始终可以使用 HTTP 操作创建请求。

后续步骤