Importar uma API gRPC (visualização)

  • Artigo

APLICA-SE A: Developer | Prémio

Este artigo mostra como importar uma definição de serviço gRPC como uma API no Gerenciamento de API. Em seguida, você pode gerenciar a API no Gerenciamento de API, proteger o acesso e aplicar outras políticas e passar solicitações de API gRPC através do gateway para o back-end gRPC.

Para adicionar uma API gRPC ao Gerenciamento de API, você precisa:

  • Carregue o arquivo de definição Protobuf (buffer de protocolo) da API para o Gerenciamento de API
  • Especifique o local do seu serviço gRPC
  • Configurar a API no Gerenciamento de API

O Gerenciamento de API oferece suporte à passagem com os seguintes tipos de métodos de serviço gRPC: unário, streaming de servidor, streaming de cliente e streaming bidirecional. Para obter informações básicas sobre o gRPC, consulte Introdução ao gRPC.

Nota

  • A importação de uma API gRPC está em visualização. Atualmente, as APIs gRPC são suportadas apenas no gateway auto-hospedado, não no gateway gerenciado para sua instância de Gerenciamento de API.
  • Atualmente, o teste de APIs gRPC não é suportado no console de teste do portal do Azure ou no portal do desenvolvedor do Gerenciamento de API.

Pré-requisitos

  • Uma instância de gerenciamento de API. Se você ainda não tiver uma, conclua o seguinte início rápido: Criar uma instância de Gerenciamento de API do Azure.

  • Um recurso de gateway provisionado em sua instância. Se você ainda não tiver um, consulte Provisionar um gateway auto-hospedado no Gerenciamento de API do Azure.

  • Um arquivo gRPC Protobuff (.proto) disponível localmente e um serviço gRPC acessível por HTTPS.

Adicionar uma API gRPC

  1. No portal do Azure, navegue até sua instância de Gerenciamento de API.

  2. No menu à esquerda, selecione APIs>+ Add API.

  3. Em Definir uma nova API, selecione gRPC.

    Captura de tela da criação de uma API gRPC no portal.

  4. Na janela Criar uma API gRPC, selecione Completo.

  5. Para uma API gRPC, você deve especificar as seguintes configurações:

    1. Em Carregar esquema, selecione um arquivo .proto local associado à API para importar.

    2. Em URL do servidor gRPC, insira o endereço do serviço gRPC. O endereço deve ser acessível por HTTPS.

    3. Em Gateways, selecione o recurso de gateway que você deseja usar para expor a API.

      Importante

      Na visualização pública, você só pode selecionar um gateway auto-hospedado. O gateway gerenciado não é suportado.

  6. Insira as configurações restantes para configurar sua API. Essas configurações são explicadas no tutorial Importar e publicar sua primeira API .

  7. Selecione Criar.

    A API é adicionada à lista de APIs . Você pode visualizar a atualização de suas configurações acessando a guia Configurações da API.

Anexar outras APIs

Você pode compor uma API de APIs expostas por diferentes serviços, incluindo:

  • Uma especificação OpenAPI
  • UMA API SOAP
  • Uma API GraphQL
  • Um Aplicativo Web hospedado no Serviço de Aplicativo do Azure
  • Aplicação de Função do Azure
  • Azure Logic Apps
  • Azure Service Fabric

Anexe uma API diferente à sua API existente usando as etapas a seguir.

Nota

Quando importar outra API, as operações são anexadas à API atual.

  1. Aceda à sua instância de API Management do Azure no portal do Azure.

    Ir para a instância do Azure API Mgmt

  2. Selecione APIs na página Visão geral ou no menu à esquerda.

    Selecionar APIs

  3. Clique em ... junto à API à qual quer anexar outra API.

  4. Selecione Importar no menu pendente.

    Selecione Importar

  5. Selecione um serviço a partir do qual quer importar uma API.

    Selecionar serviço