gRPC

gRPC は、最新の分散システムで広く採用されている、高性能で効率的なリモートプロシージャコール（RPC）フレームワークです。マイクロサービスアーキテクチャにおいて、gRPC はストリーミング機能と Protocol Buffers シリアライゼーションにより、低レイテンシかつ帯域幅の消費を抑えた効率的なサービス間通信を実現します。

前提条件

Apidog で gRPC を使用する前に、以下を確認してください。

Apidog バージョン 2.3.1 以降

gRPC サービスとメソッドを定義する .proto ファイル

gRPC サーバーエンドポイントへのアクセス権

gRPC プロジェクトの作成

新しい gRPC プロジェクトを作成するには、次の手順を実行します。

Apidog ホームページで 「新規プロジェクト」 をクリックします

「gRPC プロジェクト」 を選択します

Proto ファイルのインポート

gRPC は API-First アプローチに従っており、開発前に .proto ファイルでサービス、メソッド、メッセージを定義する必要があります。Apidog で gRPC API のデバッグを開始するには、.proto ファイルをインポートします。

初回インポート

Apidog は 3 つのインポート方法をサポートしています。

方法	説明
ローカルファイル	ローカルファイルシステムから `.proto` ファイルをアップロードします
URL	`.proto` ファイルをホストしている URL からインポートします
サーバーリフレクション	gRPC サーバーからサービスを自動的に検出します

インポート構造

選択した .proto ファイルは 1 つの Proto としてインポートされ、次のように扱われます。

サービス はサービスとしてインポートされます

RPC メソッド はメソッドとしてインポートされます

.proto ファイルが他のファイルに依存している場合、依存関係 は手動で追加する必要があります

同じパッケージを持つ依存 .proto ファイルの関連サービスもインポートされます

Proto ファイルの再インポート

.proto ファイルが変更された場合は、Apidog で更新します。

ディレクトリツリー内の Proto を右クリックします

「再インポート」 をクリックします

呼び出しメソッド

gRPC は、.proto ファイルで API を定義する際に 4 種類のメソッドタイプをサポートしています。Apidog はそのすべてをサポートしています。

メソッドタイプ	説明
Unary	単一のリクエスト、単一のレスポンス（HTTP と類似）
Server Streaming	単一のリクエストに対して、サーバーから複数のレスポンスを返します
Client Streaming	クライアントから複数のリクエストを送信し、単一のレスポンスを受け取ります
Bidirectional Streaming	双方向で複数のリクエストとレスポンスをやり取りします

Unary 呼び出し

Unary 呼び出しは HTTP リクエストと同様に機能します。

アドレスバーにサーバー URL を入力します

Message タブでメッセージ内容を JSON 形式で入力します

「呼び出し」 をクリックして呼び出しを開始します

認証や複雑なシナリオのために、Metadata と Auth 情報を設定することもできます。

ストリーミング呼び出し

ストリーミング呼び出しは WebSocket 接続と同様に動作します。呼び出しを開始した後、Message タブでメッセージを作成して送信できます。

Apidog は、以下を表示するタイムラインビューを提供します。

呼び出しステータス

送信済みメッセージ

受信済みメッセージ（時系列順）

任意のメッセージをクリックすると、その詳細を表示できます。

高度な機能

動的値の自動生成

Apidog は .proto ファイルの内容を認識し、メッセージボディを自動生成できます。

「自動生成」 ボタンをクリックしてメッセージ構造を作成します

柔軟で動的なデータ生成には、「動的値」 機能を使用します

詳細な手順については、動的値を参照してください。

変数の使用

Apidog の変数は、gRPC メッセージおよび Metadata で動的データを注入するために使用できます。

詳細な手順については、環境変数を参照してください。

TLS の有効化

gRPC API は TLS（Transport Layer Security）によるセキュアな接続をサポートしています。

TLS を有効にするには:

URL の前にあるプロトコルセレクターをクリックして、TLS ステータスを切り替えます

TLS を有効にするには、URL で grpcs:// を使用します

TLS を無効にするには、grpc:// を使用します

サーバーアドレスと環境の管理

サーバーアドレスの追加

URL アドレスバーの右側にあるプラスアイコンをクリックして、現在のサーバーアドレスを環境に追加します。

環境のサーバーアドレスの使用

右上隅で環境とサーバーアドレスを選択します

URL アドレスバーで 「デフォルトに従う」 を選択し、すべてのメソッドのデバッグに統一されたサーバーアドレスを使用します

Proto ファイルと API パラメータの表示

Proto ファイルの内容

左側のディレクトリツリーで Proto をクリックすると、.proto ファイルの生の内容を表示できます。

リクエストおよびレスポンスパラメータ

gRPC はシリアライゼーション形式として Protocol Buffers（ProtoBuf）を使用します。テキストベースの形式（JSON、XML）とは異なり、ProtoBuf は人間による読み書きに適していないバイナリ形式です。

Apidog では、使いやすさのために、すべての gRPC メッセージが JSON 形式で記述および表示されます。API 情報ページで、リクエストおよびレスポンスパラメータを JSON 形式で表示できます。

ProtoBuf から JSON への型マッピング

ProtoBuf 3	JSON	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"`

デバッグ情報の保存

デバッグが完了したら、「保存」 ボタンをクリックして以下を保存します。

サーバー URL

メッセージ

Metadata

その他の設定

これにより、チームメンバーがデバッグ設定を再利用できるようになります。

前提条件#

gRPC プロジェクトの作成#

Proto ファイルのインポート#

初回インポート#

Proto ファイルの再インポート#

呼び出しメソッド#

Unary 呼び出し#

ストリーミング呼び出し#

高度な機能#

動的値の自動生成#

変数の使用#

TLS の有効化#

サーバーアドレスと環境の管理#

サーバーアドレスの追加#

環境のサーバーアドレスの使用#

Proto ファイルと API パラメータの表示#

Proto ファイルの内容#

リクエストおよびレスポンスパラメータ#

ProtoBuf から JSON への型マッピング#

デバッグ情報の保存#