Compartilhar via

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.

Observação

Atualmente, esse recurso não está disponível em workspaces.

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 do Azure dá suporte à importação automatizada de um recurso de Aplicativo Lógico (Consumo), que é executado no ambiente de Aplicativos Lógicos multilocatário. Para obter mais informações, consulte Diferenças entre aplicativos lógicos Standard de locatário único e aplicativos lógicos multilocatários de Consumo.

Pré-requisitos

Importar e publicar uma API de back-end

  1. Navegue até seu serviço de Gerenciamento de API no portal do Azure.

  2. No menu à esquerda, na seção APIs , selecione APIs e, em seguida, selecione + Adicionar API.

  3. Selecione Aplicativo Lógico na lista Criar na lista de recursos do Azure:

    Captura de tela que mostra o tile do Aplicativo Lógico.

  4. Selecione Procurar para ver a lista de aplicativos lógicos que têm gatilho HTTP em sua assinatura. (Os aplicativos lógicos que não têm um gatilho HTTP não aparecerão na lista.)

    Captura de tela que mostra o botão Procurar.

  5. Selecione o aplicativo lógico:

    Captura de tela que mostra a janela Selecionar Aplicativo Lógico para importar.

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

  6. Adicione um sufixo da URL da API. O sufixo identifica exclusivamente a API na instância de Gerenciamento de API.

    Captura de tela que mostra os valores inseridos na janela Criar por meio do Aplicativo Lógico.

  7. Se você quiser que a API seja publicada e disponível para desenvolvedores, alterne para o modo de exibição Completo e associe a API a um Produto. Este exemplo usa o produto Ilimitado . (Você pode adicionar sua API a um produto ao criá-lo 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. Depois de assinarem, eles recebem uma chave de assinatura para qualquer API no produto. Como criador da instância de Gerenciamento de API, você é um administrador e é inscrito em cada produto por padrão.

    Em determinadas camadas, cada instância de Gerenciamento de API vem com dois produtos de exemplo padrão:

    • Inicial
    • Ilimitado

  8. Insira outras configurações de API. Você pode definir esses valores ao criar a API ou posterior acessando a guia Configurações . As configurações são explicadas no tutorial Importar e publicar sua primeira API .

  9. Selecione Criar.

Testar a API no Portal do Azure

Você pode chamar as operações diretamente do portal do Azure. Esse método fornece uma maneira conveniente de exibir e testar as operações de uma API.

Captura de tela que mostra as etapas para testar uma API.

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

  2. Na guia Teste , selecione a operação que você 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. Esse cabeçalho é para a chave de assinatura do produto associada à API.
    • Como criador da instância de Gerenciamento de API, você é um administrador, portanto, a chave é preenchida automaticamente.

  3. Selecione 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 a partir de APIs que são disponibilizadas por diferentes serviços, incluindo:

  • Uma especificação do OpenAPI
  • Uma API SOAP
  • Uma API do GraphQL
  • Um aplicativo Web hospedado no Serviço de Aplicativo do Azure
  • Azure Functions
  • Aplicativo Lógico do Azure
  • Azure Service Fabric

Observação

Quando você importa uma API, as operações são acrescentadas à API atual.

Para acrescentar uma API a uma API existente:

  1. Acesse sua instância de Gerenciamento de API do Azure no portal do Azure:

    Captura de tela que mostra a página Serviços de Gerenciamento de API.

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

    Captura de tela que mostra a seleção de APIs na página Visão geral.

  3. Selecione as reticências (...) próximas à API na qual deseja acrescentar outra API.

  4. Selecione Importar no menu suspenso:

    Captura de tela que mostra o comando Importar.

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

Observação

Cada Aplicativo Lógico tem uma operação manual-invoke. Se você quiser combinar vários aplicativos lógicos em uma API, precisará renomear a função. Para renomear a função/API, altere o valor do título no editor de Especificações do OpenAPI.

Conteúdo relacionado

  • Last updated on