gRPC é um framework de Chamada de Procedimento Remoto (RPC) eficiente e de alto desempenho, amplamente adotado em sistemas distribuídos modernos. Em arquiteturas de microsserviços, o gRPC facilita a comunicação eficiente entre serviços com baixa latência e consumo reduzido de largura de banda por meio de seus recursos de streaming e da serialização Protocol Buffers.Pré-requisitos#
Antes de usar gRPC no Apidog, certifique-se de que você tenha:Apidog versão 2.3.1 ou posterior
Arquivos .proto definindo seus serviços e métodos gRPC
Acesso a um endpoint de servidor gRPC
Criando um projeto gRPC#
Para criar um novo projeto gRPC:1.
Clique em "New Project" na página inicial do Apidog
Importando arquivos Proto#
gRPC segue uma abordagem API-First, exigindo que serviços, métodos e mensagens sejam definidos por meio de arquivos .proto antes do desenvolvimento. Importe seu arquivo .proto para começar a depurar APIs gRPC no Apidog.Importação inicial#
O Apidog oferece suporte a três métodos de importação:| Método | Descrição |
|---|
| Arquivo local | Faça upload de um arquivo .proto do seu sistema de arquivos local |
| URL | Importe de uma URL que hospeda o arquivo .proto |
| Server Reflection | Descubra automaticamente serviços de um servidor gRPC |
O arquivo .proto selecionado é importado como um Proto, em que:Serviços são importados como serviços
Métodos RPC são importados como métodos
Dependências devem ser adicionadas manualmente se o arquivo .proto depender de outros arquivos
Serviços relacionados de arquivos .proto dependentes com o mesmo pacote também são importados
Reimportando arquivos Proto#
Quando seu arquivo .proto for alterado, atualize-o no Apidog:1.
Clique com o botão direito do mouse no Proto na árvore de diretórios
Métodos de invocação#
gRPC oferece suporte a quatro tipos de método ao definir APIs em arquivos .proto. O Apidog oferece suporte a todos os quatro:| Tipo de método | Descrição |
|---|
| Unary | Requisição única, resposta única (semelhante ao HTTP) |
| Server Streaming | Requisição única, várias respostas do servidor |
| Client Streaming | Várias requisições do cliente, resposta única |
| Bidirectional Streaming | Várias requisições e respostas em ambas as direções |
Chamadas unary#
Chamadas unary funcionam de forma semelhante a requisições HTTP:1.
Insira a URL do servidor na barra de endereços
2.
Insira o conteúdo da mensagem em formato JSON na guia Message
3.
Clique em "Invoke" para iniciar a chamada
Chamadas de streaming#
Chamadas de streaming operam de forma semelhante a conexões WebSocket. Depois de iniciar a chamada, você pode escrever e enviar mensagens na guia Message.O Apidog fornece uma visualização de linha do tempo que exibe:Mensagens recebidas (em ordem cronológica)
Recursos avançados#
Gerar valores dinâmicos automaticamente#
O Apidog reconhece o conteúdo do arquivo .proto, permitindo a geração automática do corpo da mensagem:1.
Clique no botão "Auto-generate" para criar a estrutura da mensagem
2.
Use o recurso "Dynamic Values" para geração flexível e dinâmica de dados
Usando variáveis#
Variáveis do Apidog podem ser usadas em mensagens gRPC e em Metadata para injeção dinâmica de dados.Habilitando TLS#
APIs gRPC oferecem suporte a conexões seguras por meio de TLS (Transport Layer Security).Clique no seletor de protocolo antes da URL para alternar o status do TLS
Use grpcs:// na URL para habilitar TLS
Use grpc:// para desabilitar TLS
Gerenciando endereços de servidor e ambientes#
Adicionando endereços de servidor#
Clique no ícone de mais no lado direito da barra de endereços da URL para adicionar o endereço do servidor atual a um ambiente.Usando endereços de servidor do ambiente#
1.
Selecione o ambiente e o endereço do servidor no canto superior direito
2.
Escolha "Follow Default" na barra de endereços da URL para usar um endereço de servidor unificado para depurar todos os métodos
Visualizando arquivos Proto e parâmetros de API#
Conteúdo do arquivo Proto#
Clique no Proto na árvore de diretórios à esquerda para visualizar o conteúdo bruto do arquivo .proto.Parâmetros de requisição e resposta#
gRPC usa Protocol Buffers (ProtoBuf) como formato de serialização. Diferentemente de formatos baseados em texto (JSON, XML), ProtoBuf é um formato binário que não é adequado para leitura ou escrita por humanos.No Apidog, todas as mensagens gRPC são escritas e exibidas em formato JSON para facilitar o uso. Você pode visualizar parâmetros de requisição e resposta em formato JSON na página de informações da API.Mapeamento de tipos ProtoBuf para JSON#
| ProtoBuf 3 | JSON | Exemplo JSON |
|---|
| message | object | {"fooBar": v, "g": null, …} |
| enum | string | "FOO_BAR" |
| map<K,V> | object | {"k": v, …} |
| repeated V | array | [v, …] |
| bool | boolean | true, false |
| string | string | "Hello World!" |
| bytes | base64 string | "YWJjMTIzIT8kKiYoKSctPUB+" |
| int32, fixed32, uint32 | number | 1, -10, 0 |
| int64, fixed64, uint64 | string | "1", "-10" |
| float, double | number | 1.1, -10.0, 0, "NaN", "Infinity" |
Depois de concluir a depuração, clique no botão "Save" para salvar:Isso permite que os membros da equipe reutilizem sua configuração de depuração. Modified at 2026-06-11 10:21:25
