Importar um aplicativo Web do Azure como uma API

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

Este artigo mostra como usar o portal do Azure para importar um aplicativo Web do Azure como uma API para o Gerenciamento de API do Azure e testar a API importada.

Neste artigo, você aprenderá como:

Expor um aplicativo Web usando o Gerenciamento de API

O Serviço de Aplicativo do Azure é um serviço com base em HTTP para hospedagem de aplicativos Web, APIs REST e back-ends móveis. Os desenvolvedores de API podem usar suas pilhas e pipelines de tecnologia preferenciais para desenvolver APIs e publicar seus back-ends de API como aplicativos Web em um ambiente seguro e escalonável. Em seguida, eles podem usar o Gerenciamento de API para expor os aplicativos Web, gerenciar e proteger as APIs durante todo o ciclo de vida e publicá-las aos consumidores.

Usar o Gerenciamento de API para expor uma API hospedada por Aplicativos Web oferece estes benefícios:

• Desacoplar o gerenciamento e a proteção do front-end exposto aos consumidores da API do gerenciamento e monitoramento do aplicativo Web de back-end.
• Gerenciar APIs Web hospedadas como aplicativos Web no mesmo ambiente que suas outras APIs.
• Aplique políticas para alterar o comportamento da API, como limitação de taxa de chamada.
• Direcione os consumidores de API para o portal do desenvolvedor de Gerenciamento de API personalizável para que eles possam descobrir e aprender sobre suas APIs, solicitar acesso e experimentar APIs.

Para obter mais informações, confira Sobre o Gerenciamento de API.

Definição de OpenAPI versus operações curinga

O Gerenciamento de API dá suporte à importação de aplicativos Web hospedados no Serviço de Aplicativo que incluem uma definição de OpenAPI (uma definição do Swagger). No entanto, uma definição de OpenAPI não é necessária.

• Se o aplicativo Web estiver configurado com uma definição de OpenAPI, o Gerenciamento de API detectará isso. Como alternativa, você pode importar manualmente a definição para o Gerenciamento de API. Em seguida, o Gerenciamento de API cria operações de API que são mapeadas diretamente para a definição, incluindo caminhos, parâmetros e tipos de resposta necessários.

  É recomendável ter uma definição de OpenAPI, pois a API é importada para o Gerenciamento de API com alta fidelidade, proporcionando a flexibilidade para validar, gerenciar, proteger e atualizar configurações para cada operação separadamente.

• Se uma definição da OpenAPI não for fornecida, o Gerenciamento de API gerará operações curinga para os verbos HTTP comuns (GET, PUT e assim por diante). Acrescente um caminho ou parâmetros necessários a uma operação curinga para passar uma solicitação de API por meio da API de back-end.

  Com operações curinga, você ainda pode aproveitar os mesmos recursos de Gerenciamento de API, mas as operações não são definidas no mesmo nível de detalhes por padrão. Em ambos os casos, você pode editar ou adicionar operações à API importada.

Exemplo

Seu aplicativo Web de back-end pode dar suporte a duas operações GET:

• https://<app-service>.azurewebsites.net/customer/{id}
• https://<app-service>.azurewebsites.net/customers

Você importa o aplicativo Web para seu serviço de Gerenciamento de API em um caminho como https://<api>.azureapi.net/store. A tabela a seguir mostra as operações importadas para o Gerenciamento de API, com ou sem uma especificação OpenAPI:

A operação curinga permite as mesmas solicitações para o serviço de back-back que as operações na especificação OpenAPI. No entanto, as operações especificadas por OpenAPI podem ser gerenciadas separadamente no Gerenciamento de API.

Pré-requisitos

• Conclua o início rápido Criar uma instância do Gerenciamento de API do Azure.

• Verifique se há um serviço de aplicativo em sua assinatura. Para saber mais, confira a Documentação do Serviço de Aplicativo.

  Para obter informações sobre como criar uma API Web de exemplo e publicá-la como um aplicativo Web do Azure, consulte:

  • Tutorial: Criar uma API Web com o ASP.NET Core.
  • Publique um aplicativo ASP.NET Core no Azure com o Visual Studio Code.

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 o bloco Serviço de Aplicativo

   

4. Selecione Procurar para ver a lista de serviços de aplicativo em sua assinatura.

5. Selecione um serviço de aplicativo e clique no botão Selecionar . Se uma definição de OpenAPI estiver associada ao aplicativo Web selecionado, o Gerenciamento de API a buscará e a importará.

   Se uma definição de OpenAPI não for encontrada, o Gerenciamento de API exporá a API gerando operações curinga para verbos HTTP comuns.

6. Adicionar um sufixo de URL da API. O sufixo é um nome que identifica a API na instância de Gerenciamento de API. Ele deve ser exclusivo na instância de Gerenciamento de API.

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 criar o produto 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 configurá-los posteriormente acessando a guia Configurações . As configurações são explicadas no tutorial Importar e publicar sua primeira API .

9. Selecione Criar.

Testar a nova 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. Você também pode testar a API no portal do desenvolvedor ou usando suas próprias ferramentas de cliente REST.

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

2. Na guia Teste , selecione uma operação.

   A página exibe os campos dos parâmetros de consulta e os campos dos cabeçalhos. Um dos cabeçalhos é Ocp-Apim-Subscription-Key. Esse cabeçalho é para a chave de assinatura do produto associado à API. Se você criou a instância de Gerenciamento de API, já é administrador, portanto, a chave é preenchida automaticamente.

3. Pressione Enviar.

   Quando a solicitação for realizada com sucesso, o back-end responderá com 200 OK e alguns dados.

Testar uma operação curinga no portal

Quando operações curinga são geradas, as operações podem não ser mapeadas diretamente para a API de back-end. Por exemplo, uma operação GET curinga importada no Gerenciamento de API usa o caminho / por padrão. No entanto, sua API de back-end pode dar suporte a uma operação GET no caminho /api/todoItems.

Para testar o caminho /api/todoItems:

1. Selecione a API que você criou e selecione uma operação.

2. Na guia Teste , em parâmetros de modelo, atualize o valor ao lado do nome curinga (*). Por exemplo, insira api/todoItems. Esse valor é acrescentado ao caminho / para a operação curinga.

   

3. Selecione Enviar.

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

Para acrescentar uma API a uma API existente:

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

   

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

   

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

4. Selecione Importar no menu suspenso:

   

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

Conteúdo relacionado

• Limitações de importação da API
• Importar uma especificação de OpenAPI
• Importar uma API SOAP
• Importar uma API SOAP e convertê-la em REST
• Importar uma API do Serviço de Aplicativo
• Importar uma API de aplicativo de contêiner
• Importar uma API WebSocket
• Importar uma API GraphQL
• Importar um esquema do GraphQL e configurar os resolvedores de campo
• Importar uma API de aplicativo de funções
• Importar uma API de aplicativo lógico
• Importar um serviço do Service Fabric
• Importar uma API do Azure AI Foundry
• Importe uma API Azure OpenAI
• Importar uma API LLM
• Importar uma API OData
• Exportar uma API REST como um servidor MCP
• Expor um servidor MCP existente
• Importar uma API de agente A2A
• Importar metadados do SAP OData
• Importar uma API do gRPC
• Editar uma API