Migrar o Portal de API com o plano do Azure Spring Apps Enterprise para o Gerenciamento de API do Azure

Nota

Os planos Basic, Standard e Enterprise serão preteridos a partir de meados de março de 2025, com um período de aposentadoria de 3 anos. Recomendamos a transição para os Aplicativos de Contêiner do Azure. Para obter mais informações, consulte o anúncio de aposentadoria do Azure Spring Apps.

O plano de consumo padrão e dedicado será preterido a partir de 30 de setembro de 2024, com um desligamento completo após seis meses. Recomendamos a transição para os Aplicativos de Contêiner do Azure. Para obter mais informações, consulte Migrar consumo padrão e plano dedicado do Azure Spring Apps para Aplicativos de Contêiner do Azure.

Este artigo aplica-se a: ❎ Basic/Standard ✅ Enterprise

Este artigo descreve como migrar o Portal de API para o Gerenciamento de API do Azure.

O Gerenciamento de API do Azure fornece uma interface centralizada para exibir definições de API e testar rotas de API específicas diretamente do navegador. Ele também suporta logon único (SSO) para maior segurança e acesso contínuo. A migração do Portal de API com o Azure Spring Apps para o Azure API Management melhora a escalabilidade, a segurança e a integração com outros serviços do Azure.

Pré-requisitos

• Uma instância de plano existente do Azure Spring Apps Enterprise com o Portal de API habilitado.
• Um aplicativo de contêiner do Azure existente. Para obter mais informações, veja o Início Rápido: implementar a primeira aplicação de contentor com o portal do Azure.

Criar uma instância da Gestão de API

Use as seguintes etapas para criar uma instância de Gerenciamento de API:

1. No portal do Azure, procure Gerenciamento de API na barra de pesquisa.

2. Selecione Serviços de gerenciamento de API nos resultados e, em seguida, selecione Criar.

3. Forneça as seguintes informações necessárias:

   • Assinatura: selecione a assinatura do Azure para seu serviço.
   • Grupo de recursos: selecione um grupo de recursos existente ou selecione Criar novo para criar um novo.
   • Região: escolha o local ou a região para sua instância de Gerenciamento de API.
   • Nome do recurso: forneça um nome globalmente exclusivo para a instância de Gerenciamento de API.
   • Nome da organização: especifique o nome da sua organização.
   • Email do administrador: forneça um endereço de e-mail usado para notificações relacionadas à instância de Gerenciamento de API.

4. Escolha o nível de preço com base no seu caso de uso. Você sempre pode atualizar ou alterar o nível de preço mais tarde.

5. Defina configurações opcionais, como monitoramento e configurações de rede virtual.

6. Selecione Rever + criar para rever as definições e validar a configuração.

7. Após a conclusão da validação, selecione Criar. A implantação pode levar de 30 a 40 minutos.

8. Após a conclusão da implantação, navegue até a página do serviço Gerenciamento de API para exibir o serviço recém-criado.

Importar APIs expostas no Gerenciamento de API

Há duas opções para importar APIs no Gerenciamento de API: adicionar APIs manualmente ou importar um arquivo de especificação de API.

Adicionar APIs manualmente

Use as seguintes etapas para adicionar APIs manualmente:

1. Navegue até a instância de Gerenciamento de API no portal do Azure. Na seção APIs, selecione Adicionar API.

2. No painel Definir uma nova API, selecione a opção HTTP para definir manualmente uma API HTTP.

3. Forneça os seguintes valores de Noções básicas da API e selecione Criar para salvar:

   • Nome para exibição: forneça um nome para sua API.
   • Nome: insira um identificador exclusivo para a API.
   • URL do serviço Web: especifique a URL base da API de back-end dos aplicativos de contêiner.
   • Sufixo de URL da API: defina o sufixo para esta API - por exemplo, /api/customers-service.

4. Para criar novos pontos de extremidade de API, selecione Adicionar operação e use as seguintes etapas:

   1. Forneça as informações gerais. Insira Nome para exibição e Nome.
   2. Forneça os detalhes da operação, como o verbo GET - HTTP, POST, e assim por diante - URL, Parâmetros de Consulta, Solicitação e Resposta.
   3. Depois de adicionar todas as operações, salve sua API.

5. Selecione os nomes das APIs adicionadas. Você pode ver todas as operações adicionadas na guia Design .

Importar um arquivo de especificação da API

Se você tiver uma especificação OpenAPI - uma definição Swagger - de suas APIs, poderá importar diretamente para o Gerenciamento de API usando as seguintes etapas:

1. Navegue até a instância de Gerenciamento de API no portal do Azure.

2. Abra a seção APIs em APIs.

3. Selecione Adicionar API.

4. Para Criar a partir da definição, escolha a opção OpenAPI , que cria uma interface padrão independente de linguagem para APIs REST.

5. Use as seguintes etapas para criar uma API a partir de uma especificação OpenAPI:

   1. Se você tiver um arquivo de especificação de API local, selecione Selecionar um arquivo para carregar o arquivo. Como alternativa, forneça uma URL acessível publicamente para a especificação OpenAPI.
   2. Você pode refinar ainda mais as configurações da API fornecendo valores para Nome de exibição, Nome e sufixo de URL da API para as APIs.
   3. Para salvar as configurações, selecione Criar.

6. Selecione o nome das APIs adicionadas. Você pode ver todas as operações adicionadas na guia Design .

Experimente APIs no Gerenciamento de API

O Gerenciamento de API do Azure fornece um Console de Teste interno no portal do Azure, facilitando a interação com suas APIs sem a necessidade de ferramentas externas. Use as seguintes etapas para testar suas APIs:

1. Navegue até a instância de Gerenciamento de API no portal do Azure.

2. Na seção APIs, selecione a API que deseja testar na lista.

3. Escolha uma operação. Dentro da página de visão geral da API, você pode ver uma lista de operações disponíveis (endpoints). Selecione a operação que pretende testar.

4. Selecione a guia Teste para abri-la no portal do Azure.

5. Configure parâmetros de solicitação. Insira os parâmetros necessários para a solicitação, como Parâmetros de caminho, Parâmetros de consulta, Cabeçalhos ou Corpo, dependendo do método da API. Se uma API exigir um Authorization Token, certifique-se de incluí-lo no cabeçalho.

6. Envie o pedido. Depois de fornecer os detalhes da solicitação, selecione Enviar. A resposta da API é mostrada diretamente no portal do Azure, incluindo o Código de Resposta, o Corpo da Resposta e os Cabeçalhos.

7. Inspecione a resposta. Revise os dados de resposta, os códigos de status e quaisquer mensagens de erro que possam indicar problemas com a API ou a solicitação.

Migrar o logon único para o Gerenciamento de API

Se você habilitar o logon único (SSO) no Portal da API e quiser autenticar solicitações para o Gerenciamento de API também, use as seguintes etapas para configurar a identidade no Gerenciamento de API:

1. No portal do Azure, vá para sua instância de Gerenciamento de API.

2. Navegue até Identidades do portal>do desenvolvedor.

3. Selecione Adicionar e, em seguida, selecione Azure Ative Directory.

4. Preencha os campos obrigatórios:

   • ID do cliente: O aplicativo ou ID do cliente do seu aplicativo Microsoft Entra ID registrado.
   • Segredo do cliente: O segredo do aplicativo Microsoft Entra ID.
   • Locatário de entrada: o nome de domínio do locatário do Microsoft Entra ID, como yourcompany.onmicrosoft.com
   • URL de redirecionamento: normalmente https://{your-apim-instance}.developer.azure-api.net/signin.

5. Selecione Adicionar para salvar o provedor de identidade.

Você precisa adicionar a URL de redirecionamento à lista de URLs de redirecionamento permitidas do seu aplicativo cliente Microsoft Entra ID antes de salvar o novo provedor de identidade adicionado.

Para obter mais configurações para o Gerenciamento de API, consulte a documentação de Gerenciamento de API.