Partilhar via


Importar uma API 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 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.
  • Configure a API na Gestão 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 saber mais sobre o gRPC, consulte Introdução ao gRPC.

Nota

  • 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.
  • A importação é limitada a um único arquivo protobuf (.proto).

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 na 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 protobuf (.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. 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, você deve especificar as seguintes configurações:

    1. Insira um nome para exibição.

    2. Em Esquema de carregamento, selecione um arquivo .proto local associado à API a ser importado.

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

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

      Importante

      Na visualização pública, só é possível 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.

Chamar serviços gRPC com .NET

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

Anexar outras APIs

Você pode compor uma API a partir de APIs que são 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
  • Funções do Azure
  • Azure Logic Apps
  • Azure Service Fabric

Nota

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

Para acrescentar uma API a uma API existente:

  1. Vá para sua instância de Gerenciamento de API do Azure no portal do Azure:

    Captura de tela que mostra a página de 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 (...) ao lado da API à qual deseja acrescentar outra API.

  4. Selecione Importar no menu deslizante:

    Captura de tela que mostra o comando Importar.

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