Usar o portal API para VMware Tanzu

Este artigo aplica-se a:❌ Basic/Standard ✔️ Enterprise

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

O portal API é um dos componentes comerciais do VMware Tanzu. O portal de API suporta a visualização de definições de API do Spring Cloud Gateway for VMware Tanzu e testes de rotas de API específicas a partir do navegador. Ele também suporta a habilitação da autenticação de logon único (SSO) por meio da configuração.

Pré-requisitos

• Uma instância de plano do Azure Spring Apps Enterprise já provisionada com o portal de API habilitado. Para obter mais informações, consulte Guia de início rápido: criar e implantar aplicativos no Azure Spring Apps usando o plano Enterprise.
• O Spring Cloud Gateway for Tanzu é ativado durante o provisionamento e os metadados da API correspondentes são configurados.

Configurar o início de sessão único (SSO)

O portal da API suporta autenticação e autorização usando logon único (SSO) com um provedor de identidade OpenID (IdP) que suporta o protocolo OpenID Connect Discovery.

Para configurar o SSO com o Microsoft Entra ID, consulte Como configurar o logon único com o Microsoft Entra ID para o Spring Cloud Gateway e o API Portal for 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 da API

az spring api-portal update --assign-endpoint

Configurar o recurso de teste de API

O portal de API permite que você visualize APIs centralmente e experimente-as usando o recurso de teste de API. O teste de API é habilitado por padrão e essa configuração ajuda você a desativá-lo em toda a instância do portal da API. Para obter mais informações, consulte a seção Experimentar APIs no portal da 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 OpenAPI Spec no Spring Cloud Gateway for Tanzu

Esta seção descreve como exibir e experimentar APIs com definições de esquema no portal de API. Use as etapas a seguir para configurar o roteamento de API com uma URL de especificação OpenAPI no Spring Cloud Gateway for 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 acessível publicamente, como o URI https://petstore3.swagger.io/api/v3/openapi.json, que inclui a especificação OpenAPI.
   • A segunda opção é colocar a definição 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 gerar a especificação OpenAPI automaticamente, para que o URI possa ser como 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 o Spring Cloud Gateway para propriedades 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 aplicativos.

   Para criar regras para acessar o aplicativo no Spring Cloud Gateway para configuração de rota Tanzu, salve o seguinte conteúdo 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 open_api.uri valor é o ponto de extremidade público ou URI construído na segunda etapa acima. Você pode adicionar predicados e filtros para caminhos definidos em sua especificação 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. Você também pode visualizar as rotas no portal.

Exibir APIs expostas no portal da API

Selecione a endpoint URL opção para ir para o portal da API. Você vê todas as rotas configuradas no Spring Cloud Gateway for Tanzu.

Experimente APIs no portal API

Use as seguintes etapas para experimentar APIs:

1. Selecione a API que você gostaria de experimentar.

2. Selecione EXECUTAR e a resposta será exibida.

   

Ativar/desativar o portal da API após a criação do serviço

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

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óximos passos

• Azure Spring Apps