gRPCurlとBloomRPC

When building gRPC services, it's crucial to have tools that let you easily test and interact with them. Unlike REST APIs, which often use HTTP clients like Postman or curl, gRPC uses a binary protocol (Protobuf over HTTP/2) that traditional tools can't understand.

This lesson introduces two popular tools: gRPCurl for command-line interaction and BloomRPC for a user-friendly graphical interface.

gRPCurl is a powerful command-line tool that lets you interact with gRPC servers. Think of it as curl, but specifically designed for gRPC.

• It can list services and methods exposed by a gRPC server.
• It can describe the Protobuf message types used by these methods.
• It can invoke RPC methods with arbitrary Protobuf messages.

It's incredibly useful for quick testing, scripting, and debugging.

gRPCurl is a single binary, making it easy to install. You can download pre-compiled binaries from its GitHub releases page for your operating system (Linux, macOS, Windows).

Alternatively, if you have Go installed, you can install it using the Go toolchain:

Once installed, you can use gRPCurl to inspect a running gRPC server. Let's imagine a simple Greeter service running on localhost:50051. First, we can list the available services:

To understand what a specific service or method expects, you can use the describe command. This shows you the Protobuf schema for the inputs and outputs.

For our Greeter service, let's describe the SayHello method:

Now, let's actually call the SayHello method. We need to specify the server address, the method name, and the input data as a JSON payload using the -d flag.

The -plaintext flag is used if your server is not using TLS/SSL (common for local development).

While gRPCurl is great for scripting, sometimes a graphical user interface (GUI) makes testing more intuitive. BloomRPC is a popular open-source GUI client for gRPC services.

It provides a visual way to interact with your services, similar to how Postman works for REST APIs.

BloomRPC simplifies gRPC testing with several user-friendly features:

• Schema Discovery: Imports .proto files to automatically discover services and methods.
• Request Editor: Provides an intuitive JSON editor for constructing request messages.
• Response Viewer: Displays server responses clearly.
• History: Keeps a record of past requests, making it easy to re-run or modify them.
• Streaming Support: Handles all four gRPC communication patterns (unary, server, client, bidirectional streaming).

To use BloomRPC, you typically:

1. Add Protobuf Definition: Load your .proto files (or an entire directory) into BloomRPC.
2. Select Service/Method: Choose the specific service and method you want to test from the sidebar.
3. Edit Request: BloomRPC auto-generates a JSON template for the request message. Fill in the required data.
4. Send Request: Click the 'Play' button to send the request to your gRPC server.
5. View Response: The server's response will be displayed in the response panel.

In this lesson, we explored two essential tools for working with gRPC services:

• gRPCurl: A versatile command-line tool for scripting, debugging, and quick interactions with gRPC servers.
• BloomRPC: A user-friendly graphical interface that simplifies testing with visual schema discovery and request/response editing.

Mastering these tools will significantly boost your productivity when developing and troubleshooting gRPC-based applications. They provide different but equally valuable approaches to ensure your gRPC services are working as expected.