Chame as suas próprias APIs Web e APIs REST de fluxos de trabalho no Azure Logic Apps

Aplica-se a: Azure Logic Apps (Consumo e Standard)

Quando você tiver APIs Web ou APIs REST existentes que deseja chamar de fluxos de trabalho nos Aplicativos Lógicos do Azure, você deve primeiro concluir algumas etapas de configuração antes de poder chamar essas APIs. Principalmente, você deve implantar suas APIs como aplicativos Web ou aplicativos de API. Você pode executar essa tarefa hospedando suas APIs no Serviço de Aplicativo do Azure, uma plataforma de nuvem que fornece hospedagem de API altamente escalável e fácil.

No App Service, pode implementar as suas APIs como aplicações Web, mas considere implementá-las como aplicações de API. Essa abordagem facilita seu trabalho quando você cria, hospeda e consome APIs na nuvem e em ambientes locais. Você não precisa alterar nenhum código em suas APIs para implantar em um aplicativo de API.

Você pode chamar qualquer API de um fluxo de trabalho, mas para obter a melhor experiência, adicione metadados do Swagger ao seu aplicativo Web ou aplicativo de API. Este documento Swagger descreve suas operações e parâmetros de API, o que ajuda os fluxos de trabalho de aplicativos lógicos a funcionar melhor e mais facilmente com sua API. Você também deve configurar o CORS (Cross-Origin Resource Sharing) em seu aplicativo Web ou aplicativo de API para que seu fluxo de trabalho possa acessar sua API.

Este guia mostra como adicionar um documento Swagger, configurar o CORS para seu aplicativo Web ou aplicativo de API e fornecer opções para chamar sua API de um fluxo de trabalho depois de concluir a implantação e hospedagem de sua API no Serviço de Aplicativo.

Para obter mais informações, consulte:

• Serviço de Aplicações do Azure
• Criar e implantar um aplicativo Web ASP.NET
• Criar hospedar uma API RESTful com CORS no Serviço de Aplicativo do Azure

Pré-requisitos

• Uma conta do Azure com uma assinatura ativa. Se você não tiver uma assinatura, crie uma conta gratuita.

• Uma API Web ou API REST que segue um dos padrões compatíveis com fluxos de trabalho nos Aplicativos Lógicos do Azure e é implantada no Serviço de Aplicativo como um aplicativo Web ou aplicativo de API.

  Para obter mais informações, consulte:

  • Criar e implantar um aplicativo Web ASP.NET
  • Criar hospedar uma API RESTful com CORS no Serviço de Aplicativo do Azure

Adicionar acesso Swagger e CORS ao seu aplicativo Web ou aplicativo de API

Quando você adiciona um documento Swagger ao seu aplicativo Web ou aplicativo de API, o designer de fluxo de trabalho nos Aplicativos Lógicos do Azure pode localizar e mostrar mais facilmente as operações e os parâmetros disponíveis em sua API. Você também deve configurar o CORS (Cross-Origin Resource Sharing) em seu aplicativo Web ou aplicativo de API para que seu fluxo de trabalho possa acessar sua API.

Para tornar o documento Swagger acessível a partir do seu fluxo de trabalho no designer, na sua aplicação web ou aplicação de API, defina as propriedades da definição da API e o acesso CORS.

1. No portal do Azure, localize e abra seu aplicativo Web ou recurso de aplicativo de API.

2. Na barra lateral de recursos do aplicativo, selecione Visão geral.

3. Na guia Propriedades , em Domínios, na propriedade Domínio padrão , copie e salve o nome do site em algum lugar para a próxima etapa.

4. Na barra lateral de recursos do aplicativo, em API, selecione Definição de API. Para o local da definição da API, insira a URL do arquivo JSON do Swagger, que normalmente usa o seguinte formato, mas pode ser diferente se o arquivo Swagger usar uma especificação de API mais recente:

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

   O exemplo a seguir mostra uma URL Swagger com a especificação de API mais recente:

   

5. Quando terminar, selecione Guardar.

6. Na barra lateral de recursos do aplicativo, em API, selecione CORS.

7. Para Origem Permitida, defina a política CORS como '*', o que significa permitir todos.

   Essa configuração permite solicitações do designer de fluxo de trabalho nos Aplicativos Lógicos do Azure.

   

8. Na barra de ferramentas, selecione Salvar.

Para obter mais informações, consulte Hospedar uma API RESTful com CORS no Serviço de Aplicativo do Azure.

Execute a sua API a partir do fluxo do seu trabalho

Depois de configurar a URL de definição de API e o CORS, suas operações de API aparecem na galeria de conectores para você localizar e adicionar ao seu fluxo de trabalho.

• Para exibir sites que têm URLs OpenAPI, você pode navegar em seus sites de assinatura no designer de fluxo de trabalho.

• Para visualizar as ações e entradas disponíveis apontando para um documento Swagger, use o gatilho ou ação HTTP + Swagger .

• Para chamar qualquer API, incluindo APIs que não têm ou expõem um documento Swagger, você sempre pode criar uma solicitação com a ação HTTP.

Conteúdo relacionado

• Conectores personalizados nos Aplicativos Lógicos do Azure