Compartilhar via

Chame suas próprias APIs Web e APIs REST de fluxos dos trabalho nos Aplicativos Lógicos do Azure

Aplica-se a: Aplicativos Lógicos do Azure (Consumo + Standard)

Quando você tiver APIs Web existentes ou APIs REST que deseja chamar de fluxos de trabalho nos Aplicativos Lógicos do Azure, primeiro conclua algumas etapas de instalaçã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 escalonável e fácil.

No Azure App Service, você pode implantar suas APIs como aplicativos Web, mas considere implantar suas APIs como aplicativos de API. Essa abordagem facilita seu trabalho ao criar, hospedar e consumir 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 do Swagger descreve suas operações e parâmetros de API, o que ajuda os fluxos de trabalho do aplicativo lógico a trabalhar melhor e mais facilmente com sua API. Você também deve configurar o CORS (Compartilhamento de Recursos entre Origens) 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 do 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 a hospedagem para sua API no Serviço de Aplicativo.

Para obter mais informações, consulte:

Pré-requisitos

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

Quando você adiciona um documento Swagger ao seu aplicativo da Web ou aplicativo de API, o designer de fluxo de trabalho nos Aplicativos Lógicos do Azure pode encontrar e exibir mais facilmente as operações e parâmetros disponíveis na sua API. Você também deve configurar o CORS (Compartilhamento de Recursos entre Origens) em seu aplicativo Web ou aplicativo de API para que seu fluxo de trabalho possa acessar sua API.

Para tornar seu documento Swagger legível a partir do fluxo de trabalho no designer, no seu aplicativo web ou aplicativo de API, configure as propriedades da definição da API e o acesso do CORS.

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

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

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

  4. Na barra lateral do recurso do aplicativo, em API, selecione a definição de API. Para o local de 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 do Swagger com a especificação de API mais recente:

    A captura de tela mostra o portal do Azure, a página de definição de API do aplicativo Web e a URL do documento Swagger da API.

  5. Quando terminar, selecione Salvar.

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

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

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

    A captura de tela mostra o painel CORS do aplicativo Web com origens permitidas definidas como *, o que permite tudo.

  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.

Chame sua API a partir do fluxo de trabalho

Depois de configurar a URL de definição de API e o CORS, suas operações de API aparecerão na galeria de conectores para encontrar e adicionar ao fluxo de trabalho.

  • Para exibir sites que têm URLs OpenAPI, navegue pelos sites de assinatura no designer de fluxo de trabalho.

  • Para exibir as ações e entradas disponíveis apontando para um documento do 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 requisição com a ação HTTP.

Conteúdo relacionado

  • Last updated on