Procedimento de implementação

Pré-requisitos

• O cliente e o servidor são do tipo gRPC.
• O servidor tem um arquivo proto que define os parâmetros de solicitação e resposta da API. O arquivo proto é usado no gRPC para definir estruturas de dados e APIs de serviço. Ele descreve estruturas de dados e interações usando protobuf e serve como um contrato para a comunicação entre o cliente e o servidor.

Criação de uma API

1. Vá para o console do APIG.
2. Selecione um gateway na parte superior do painel de navegação.
3. No painel de navegação, escolha API Management > APIs.
4. Clique em Create API > Create gRPC API. Para obter detalhes, consulte Criação de uma API de gRPC.
5. Configure as informações de front-end e clique em Next.

   Tabela 1 Configuração de front-end

   Parâmetro	Descrição
   API Name	Insira um nome que esteja em conformidade com regras específicas para facilitar a pesquisa.
   Group	A opção padrão é DEFAULT.
   URL	Method: método de solicitação da API. Padrão: POST. Protocol: protocolo de solicitação da API. Padrão: GRPCS. Subdomain Name: o sistema aloca automaticamente um nome de subdomínio para cada grupo de APIs para testes internos. O nome do subdomínio pode ser acessado 1000 vezes por dia. Path: caminho para solicitar a API. Neste exemplo, insira /helloworld.Greeter. Para obter detalhes sobre o caminho da solicitação, consulte o arquivo proto. helloworld indica o nome do pacote e Greeter indica o nome do serviço.
   Gateway Response	Selecione uma resposta a ser exibida se o gateway falhar ao processar uma solicitação de API. A resposta de gateway padrão é default.
   Matching	Selecione Prefix match.
   Authentication Mode	Modo de autenticação da API. Selecione None.

6. Configure as informações de back-end e clique em Next.

   Tabela 2 Configuração de back-end

   Parâmetro	Descrição
   Load Balance Channel	Determine se o serviço de back-end será acessado usando um canal de balanceamento de carga. Para este exemplo, selecione Skip.
   URL	Method: método de solicitação da API. Padrão: POST. Protocol: protocolo de solicitação do serviço de back-end. Padrão: GRPCS. Backend Address: endereço e porta do serviço de back-end. Path: caminho do serviço de back-end. Neste exemplo, insira /.

7. Clique em Finish.
   

   Na página APIs, o URL da API mostra apenas o nome e o caminho do domínio. Ele não mostra o método de solicitação ou protocolo. Ao enviar uma solicitação gRPC, insira o nome do domínio.

   

Publicação da API

1. Na guia APIs, selecione a API criada e clique em Publish.
2. Selecione o ambiente onde a API será publicada e insira uma descrição.
3. Clique em OK. Depois que a API é publicada, o ponto de exclamação (!) vermelho no canto superior esquerdo do botão Publish desaparece.

Verificação da API

Use a ferramenta de teste da API para chamar a API criada ou invoque essa API em um cliente.

1. Insira o nome de domínio de depuração do grupo da API.
2. Importe o arquivo proto do servidor.
   O arquivo proto contém o seguinte conteúdo:

   syntax = "proto3";
   package helloworld;
   // The greeting service definition.
   service Greeter {
   // Sends a greeting
   rpc SayHello (HelloRequest) returns (HelloReply) {}
   }
   // The request message containing the user's name.
   message HelloRequest {
   string name = 1;
   }
   // The response message containing the greetings
   message HelloReply {
   string message = 1;
   } 

   • helloworld: nome do pacote
   • Greeter: nome do serviço
   • SayHello: nome do método
   • HelloRequest: corpo da solicitação
   • HelloReply: corpo de resposta

3. Insira uma solicitação de API na área message de acordo com o arquivo proto.

   {
       "name": "world"
   }

4. Clique em Invoke para enviar a solicitação.
5. Veja a resposta na área Response. Se o código de status 0 OK for exibido, a invocação será bem-sucedida.