Usar o portal de API para o VMware Tanzu

Este artigo se aplica a(o):❌ Básico/Standard ✔️ Enterprise

Esse artigo mostra como usar o portal API para VMware Tanzu com o plano Azure Spring Apps Enterprise.

O portal de API é um dos componentes comerciais do VMware Tanzu. O portal de API oferece suporte à visualização de definições de API do Spring Cloud Gateway para VMware Tanzu e ao teste de rotas de API específicas do navegador. Ele também dá suporte à habilitação da autenticação de SSO (logon único) por meio da configuração.

Pré-requisitos

• Uma instância do plano Enterprise do Azure Spring Apps já provisionada com portal de API habilitado. Para obter mais informações, confira Início Rápido: criar e implantar aplicativos nos Aplicativos Spring do Azure usando o plano Enterprise.
• O Spring Cloud Gateway para Tanzu é habilitado durante o provisionamento e os metadados de API correspondentes são configurados.

Configurar logon único (SSO)

O portal de API dá suporte à autenticação e à autorização usando o SSO (logon único) com um IdP (provedor de identidade) OpenID compatível com o protocolo de descoberta do OpenID Connect.

Para configurar o SSO com o Microsoft Entra ID, veja Como configurar o logon único com o Microsoft Entra ID para Spring Cloud Gateway e API Portal para Tanzu.

Configurar a contagem de instâncias

az spring api-portal update --instance-count <number>

Atribuir um ponto de extremidade público para o portal de API

az spring api-portal update --assign-endpoint

Configurar o recurso de teste da API

O portal de API permite que você visualize APIs centralmente e experimente-as usando o recurso de teste de API. A teste de API está habilitada por padrão e essa configuração ajuda você a desativá-la em toda a instância do portal de API. Para obter mais informações, veja a seção Experimentar APIs no portal de API.

az spring api-portal update \
    --resource-group <resource-group-name> \
    --service <Azure-Spring-Apps-service-instance-name> \
    --enable-api-try-out

az spring api-portal update \
    --resource-group <resource-group-name> \
    --service <Azure-Spring-Apps-service-instance-name> \
    --enable-api-try-out false

Configurar o roteamento de API com o OpenAPI Spec no Spring Cloud Gateway para Tanzu

Esta seção descreve como exibir e experimentar as APIs com definições de esquema no portal da API. Use as etapas a seguir para configurar o roteamento de API com uma URL de especificação do OpenAPI no Spring Cloud Gateway para Tanzu.

1. Crie um aplicativo no Azure Spring Apps para o qual o gateway roteia o tráfego.

2. Gere a definição de OpenAPI e obtenha o URI para acessá-la. As duas opções de URI a seguir são aceitas:

   • A primeira opção é usar um ponto de extremidade publicamente acessível, como a URI https://petstore3.swagger.io/api/v3/openapi.json, que inclui a especificação do OpenAPI.
   • A segunda opção é colocar a definição de OpenAPI no caminho relativo do aplicativo no Azure Spring Apps e construir o URI no formato http://<app-name>/<relative-path-to-OpenAPI-spec>. Você pode escolher ferramentas como SpringDocs para gerar a especificação do OpenAPI automaticamente, para que o URI possa ser semelhante a http://<app-name>/v3/api-docs.

3. Use o comando a seguir para atribuir um ponto de extremidade público ao gateway para acessá-lo.

   az spring gateway update --assign-endpoint
   

4. Use o seguinte comando para configurar as propriedades do Spring Cloud Gateway para Tanzu:

   az spring gateway update \
       --api-description "<api-description>" \
       --api-title "<api-title>" \
       --api-version "v0.1" \
       --server-url "<endpoint-in-the-previous-step>" \
       --allowed-origins "*"
   

5. Configure regras de roteamento para os aplicativos.

   Para criar regras para acessar o aplicativo na configuração de rotas do Spring Cloud Gateway para Tanzu, salve o conteúdo a seguir no arquivo sample.json.

   {
      "open_api": {
         "uri": "https://petstore3.swagger.io/api/v3/openapi.json"
      },
      "routes": [
         {
            "title": "Petstore",
            "description": "Route to application",
            "predicates": [
               "Path=/pet",
               "Method=PUT"
            ],
            "filters": [
               "StripPrefix=0"
            ]
         }
      ]
   }
   

   O valor open_api.uri é o ponto de extremidade público ou URI construído na segunda etapa acima. É possível adicionar predicados e filtros aos caminhos definidos na especificação do OpenAPI.

   Use o seguinte comando para aplicar a regra ao aplicativo criado na primeira etapa:

   az spring gateway route-config create \
       --name sample \
       --app-name <app-name> \
       --routes-file sample.json
   

6. Verifique a resposta das rotas criadas. Também é possível exibir as rotas no portal.

Exibir APIs expostas no portal de API

Selecione o endpoint URL para acessar o portal de API. Você vê todas as rotas configuradas no Spring Cloud Gateway for Tanzu.

Experimentar APIs no portal de API

Use as seguintes etapas para experimentar as APIs:

1. Selecione a API que você deseja experimentar.

2. Selecione EXECUTE e a resposta aparecerá.

   

Habilitar/desabilitar o portal API após a criação do serviço

Você pode habilitar e desabilitar o portal API após a criação do serviço usando o portal do Azure ou a CLI do Azure. Antes de desativar o portal API, é necessário cancelar a atribuição do seu ponto final.

az spring api-portal create \
    --resource-group <resource-group-name> \
    --service <Azure-Spring-Apps-service-instance-name>

az spring api-portal delete \
    --resource-group <resource-group-name> \
    --service <Azure-Spring-Apps-service-instance-name>

Próximas etapas

• Azure Spring Apps