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

Observação

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

O plano consumo e dedicado Standard 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 mais informações, confira Migrar o plano dedicado e consumo Standard dos Aplicativos Spring do Azure para os Aplicativos de Contêiner do Azure.

Este artigo se aplica a: ❎ Básico/Padrão ✅ 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 dá suporte ao SSO (logon único) para melhor segurança e acesso contínuo. A migração do Portal de API com os Aplicativos Spring do Azure para o Gerenciamento de API do Azure aprimora a escalabilidade, a segurança e a integração com outros serviços do Azure.

Pré-requisitos

• Uma instância do plano Enterprise dos Aplicativos Spring do Azure existente com o Portal de API habilitado.
• Um aplicativo de contêiner do Azure existente. Para obter mais informações, confira Guia de Início Rápido: implantar seu primeiro aplicativo de contêiner usando o portal do Azure.

Criar uma instância de Gerenciamento de API

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

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

2. Selecione os serviços de Gerenciamento de API nos resultados e selecione Criar.

3. Forneça as seguintes informações obrigatórias:

   • Assinatura: selecione a assinatura do Azure para seu serviço.
   • Grupo de recursos: selecione um grupo de recursos 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 global 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 email usado para notificações relacionadas à instância de Gerenciamento de API.

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

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

6. Selecione Examinar + criar para examinar as configurações e validar a configuração.

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

8. Depois que a implantação for concluída, navegue até a página do serviço de 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 básicos de API e selecione Criar para salvar:

   • Nome de 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 essa API – por exemplo, /api/customers-service.

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

   1. Forneça as informações gerais. Insira Nome de exibição e Nome.
   2. Forneça os detalhes da operação, como o verbo HTTP - GET, 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 de API

Se você tiver uma especificação OpenAPI, uma definição do 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 e 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, escolha 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 de API fornecendo valores para Nome de Exibição, Nomee Sufixo de URL de 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.

Experimentar 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 precisar 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 você 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 (pontos de extremidade). Selecione a operação que deseja testar.

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

5. Configurar 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 de API. Se uma API exigir um Authorization Token, certifique-se de incluí-lo no cabeçalho.

6. Enviar a solicitação. 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. Examine os dados de resposta, os códigos de status e as mensagens de erro que possam indicar problemas com a API ou a solicitação.

Migrar logon único para o Gerenciamento de API

Se você habilitar o SSO (logon único) no Portal de 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. Vá até a sua instância de Gerenciamento de API do Azure no portal do Azure.

2. Navegue até Portal do Desenvolvedor>identidades.

3. Selecione Adicionar e selecione Azure Active Directory.

4. Preencha os campos obrigatórios:

   • ID do cliente: a ID do aplicativo ou do cliente do aplicativo registrado do Microsoft Entra ID.
   • 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 do 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 do Gerenciamento de API.