Share via

Usar o portal API para VMware Tanzu

  • Artigo

Nota

Azure Spring Apps é o novo nome para o serviço Azure Spring Cloud. Embora o serviço tenha um novo nome, você verá o nome antigo em alguns lugares por um tempo enquanto trabalhamos para atualizar ativos, como capturas de tela, vídeos e diagramas.

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

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.

Nota

Apenas os servidores de autorização que suportam o protocolo OpenID Connect Discovery são suportados. Certifique-se de configurar o servidor de autorização externo para permitir redirecionamentos de volta para o portal da API. Consulte a documentação do servidor de autorização e adicione https://<api-portal-external-url>/login/oauth2/code/sso à lista de URIs de redirecionamento permitidos.

Property Necessário? Description
emissorUri Sim O URI que o aplicativo afirma como seu Identificador de Emissor. Por exemplo, se o issuer-uri fornecido for "https://example.com", então uma solicitação de configuração do provedor OpenID será feita para "https://example.com/.well-known/openid-configuration". Espera-se que o resultado seja uma resposta de configuração do provedor OpenID.
clientId Sim O ID do cliente OpenID Connect fornecido pelo seu IdP
clientSecret Sim O segredo do cliente OpenID Connect fornecido pelo seu IdP
âmbito Sim Uma lista de escopos a serem incluídos nos tokens de identidade JWT. Essa lista deve ser baseada nos escopos permitidos pelo seu provedor de identidade

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.

Nota

Se você configurar a propriedade SSO errada, como a senha errada, deverá remover toda a propriedade SSO e adicionar novamente a configuração correta.

Configurar a contagem de instâncias

Use as seguintes etapas para configurar a contagem de instâncias usando o portal de API:

  1. Navegue até sua instância de serviço e selecione Portal de API.
  2. Selecione Dimensionar.
  3. Configure a contagem de instâncias e selecione Salvar.

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

Use as seguintes etapas para atribuir um ponto de extremidade público ao portal da API:

  1. Selecione Portal da API.
  2. Selecione Visão geral para exibir o estado de execução e os recursos alocados no portal da API.
  3. Selecione Sim ao lado de Atribuir ponto de extremidade para atribuir um ponto de extremidade público. Um URL é gerado em poucos minutos.
  4. Salve o URL para uso posterior.

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.

Use as seguintes etapas para habilitar ou desabilitar o teste de API:

  1. Navegue até sua instância de serviço e selecione Portal de API.
  2. Selecione Configuração.
  3. Selecione ou desmarque Ativar teste de API e, em seguida, selecione Salvar.

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

Nota

Leva vários minutos para sincronizar entre o Spring Cloud Gateway para Tanzu e o portal 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.

Captura de tela do portal da API que mostra as rotas configuradas.

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.

    Captura de tela do portal da API que mostra a opção Executar selecionada.

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.

Use as seguintes etapas para habilitar ou desabilitar o portal de API usando o portal do Azure:

  1. Navegue até o recurso de serviço e selecione Portal de API.
  2. Selecione Gerir.
  3. Selecione ou desmarque o portal Ativar API e, em seguida, selecione Salvar.
  4. Agora você pode visualizar o estado do portal da API na página do portal da API.

Próximos passos