Compartilhar via


Importar uma API do gRPC

APLICA-SE A: Desenvolvedor | Premium

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 por meio 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 no Gerenciamento de API.
  • Especifique a localização do serviço gRPC.
  • Configurar a API no Gerenciamento de API.

O Gerenciamento de API dá 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 saber mais sobre gRPC, consulte Introdução ao gRPC.

Observação

  • Atualmente, só há suporte para as APIs gRPC no gateway auto-hospedado, não no gateway gerenciado da sua instância do Gerenciamento de API.
  • Atualmente, não há suporte para o teste de APIs gRPC no console de teste do portal do Azure nem no portal do desenvolvedor do Gerenciamento de API.
  • A importação é limitada a um único arquivo protobuf (.proto).

Pré-requisitos

Adicionar uma API gRPC

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

  2. Em APIs no menu da barra lateral, selecione APIs.

  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, é preciso especificar as seguintes configurações:

    1. Insira um nome de exibição.

    2. Para carregar o esquema, selecione um arquivo .proto local associado à API a ser importada.

    3. Para a URL do servidor gRPC, insira o endereço do serviço gRPC. Esse endereço precisa estar acessível via HTTPS.

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

      Importante

      Na versão prévia pública, só é possível selecionar um gateway auto-hospedado. Não há suporte para o gateway Gerenciado.

  6. Insira as configurações restantes para definir 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. Visualize e atualize as configurações acessando a guia Configurações da API.

Chamar os serviços gRPC com o .NET

Para obter informações sobre como chamar os serviços gRPC com o .NET, consulte os artigos a seguir:

Acrescentar outras APIs

Você pode compor uma API a partir de APIs que são disponibilizadas por diferentes serviços, incluindo:

  • Uma especificação do OpenAPI
  • Uma API SOAP
  • Uma API do GraphQL
  • Um aplicativo Web hospedado no Serviço de Aplicativo do Azure
  • Azure Functions
  • Aplicativo Lógico do Azure
  • Azure Service Fabric

Observação

Quando você importa uma API, as operações são acrescentadas à API atual.

Para acrescentar uma API a uma API existente:

  1. Acesse sua instância de Gerenciamento de API do Azure no portal do Azure:

    Captura de tela que mostra a página Serviços de Gerenciamento de API.

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

    Captura de tela que mostra a seleção de APIs na página Visão geral.

  3. Selecione as reticências (...) próximas à API na qual deseja acrescentar outra API.

  4. Selecione Importar no menu suspenso:

    Captura de tela que mostra o comando Importar.

  5. Selecione um serviço de onde será importada a API.