Importar um aplicativo lógico como uma API

APLICA-SE A: todas as camadas do Gerenciamento de API

Este artigo mostra como importar um Aplicativo Lógico como uma API e testar a API importada.

Neste artigo, você aprenderá como:

  • Importar um aplicativo lógico como uma API
  • Testar a API no Portal do Azure

Observação

O Gerenciamento de API dá suporte à importação automatizada de um recurso de Aplicativo Lógico (Consumo). que é executado no ambiente de Aplicativos Lógicos multilocatário. Saiba mais sobre Aplicativos Lógicos de locatário único versus multilocatário.

Pré-requisitos

Navegar até a instância de Gerenciamento de API

  1. No portal do Azure, pesquise e selecione serviços de Gerenciamento de API.

    Selecione Serviços de Gerenciamento de API

  2. Na página Serviços de Gerenciamento de API, selecione a sua instância de Gerenciamento de API.

    Selecione a sua instância de Gerenciamento de API

Importar e publicar uma API de back-end

  1. Navegue até o serviço de Gerenciamento de API no portal do Azure e selecione APIs no menu.

  2. Selecione Aplicativo Lógico na lista Adicionar uma nova API.

    Selecionar a categoria de aplicativo lógico

  3. Pressione Procurar para ver a lista de Aplicativos Lógicos com gatilho HTTP em sua assinatura.

    • Os aplicativos lógicos sem o gatilho HTTP não serão exibidos na lista.

    Procurar aplicativos lógicos existentes com o gatilho correto

  4. Selecione o aplicativo lógico.

    Selecionar aplicativo lógico

  5. O Gerenciamento de API localiza o Swagger associado ao aplicativo selecionado, busca-o e importa-o.

  6. Adicione um sufixo da URL da API.

    • O sufixo identifica exclusivamente essa API específica nessa instância do Gerenciamento de API.

    Concluir os campos

  7. Se você quiser que a API seja publicada e fique disponível para os desenvolvedores, alterne para a exibição Completa e associe-a a um Produto. Usamos o produto "Ilimitado" neste exemplo.

    • Você pode adicionar sua API a um produto durante a criação ou posteriormente por meio da guia Configurações.

    Observação

    Os produtos são associações de uma ou mais APIs oferecidas aos desenvolvedores por meio do portal do desenvolvedor. Primeiro, os desenvolvedores precisam assinar um produto para obter acesso à API. Após a assinatura, eles obtêm uma chave de assinatura para qualquer API no produto. Como criador da instância do Gerenciamento de API, você é um administrador e, por padrão, tem a assinatura de todos os produtos.

    Cada instância do Gerenciamento de API é fornecida com dois produtos de exemplo padrão:

    • Inicial
    • Ilimitado
  8. Insira outras configurações de API.

  9. Selecione Criar.

Testar a API no Portal do Azure

As operações podem ser chamadas diretamente do portal do Azure, o que oferece uma maneira fácil de exibir e testar as operações de uma API.

Testar o aplicativo lógico

  1. Selecione a API que você criou na etapa anterior.

  2. Pressione a guia Testar.

  3. Selecione a operação que deseja testar.

    • A página exibe os campos dos parâmetros de consulta e dos cabeçalhos.
    • Um dos cabeçalhos é "Ocp-Apim-Subscription-Key", para a chave de assinatura do produto que está associada a essa API.
    • Como criador da instância do Gerenciamento de API, você já é um administrador. Portanto, a chave é preenchida automaticamente.
  4. Pressione Enviar.

    • Quando o teste for bem-sucedido, o back-end responderá com 200 OK e com os dados.

Acrescentar outras APIs

Você pode compor uma API de APIs expostas por diferentes serviços, incluindo:

  • Uma especificação do OpenAPI
  • Uma API SOAP
  • Uma API da GraphQL
  • Um aplicativo Web hospedado no Serviço de Aplicativo do Azure
  • Aplicativo de Funções do Azure
  • Aplicativos Lógicos do Azure
  • Azure Service Fabric

Acrescente uma API diferente da API existente usando as etapas a seguir.

Observação

Ao importar outra API, as operações são acrescentadas à sua API atual.

  1. Vá para sua instância de Gerenciamento de API do Azure no portal do Azure.

    Acessar a instância do Gerenciamento de API do Azure

  2. Selecione APIs na página Visão geral ou no menu à esquerda.

    Selecionar APIs

  3. Clique em ... ao lado da API à qual você deseja acrescentar outra API.

  4. Selecione Importar no menu suspenso.

    Selecionar Importar

  5. Selecione um serviço de onde será importada a API.

    Selecione o serviço

Observação

Cada aplicativo lógico tem uma operação manual-invoke. Para incluir a API de vários aplicativos lógicos e evitar a colisão, você precisará renomear a função. Para renomear a função/a API, navegue até o editor de Especificação de OpenAPI e altere o valor do título.

Próximas etapas