gRPCは、Protocol Buffers(protobuf)というシリアライゼーション形式を使用して、クライアントとサーバー間の効率的な通信を可能にします。クライアントとサーバーの間でストリームや双方向通信をサポートすることができます。また、多言語に対応しており、さまざまなプログラミング言語で使用することができます。
最近、Apidogは、2023年7月12日のV2.3.2のリリースにより、gRPC APIにも対応できるようになりました!現在、最新バージョンのApidogを入手して、gRPCプロジェクトを作成して、デバッグできるようになりました。ApidogでgRPCを利用する場合、利用できる機能は多数あります。
Apidog公式サイト:https://apidog.com/jp/
最近、Apidogは、2023年7月12日のV2.3.2のリリースにより、gRPC APIにも対応できるようになりました!現在、最新バージョンのApidogを入手して、gRPCプロジェクトを作成して、デバッグできるようになりました。ApidogでgRPCを利用する場合、利用できる機能は多数あります。
Apidog公式サイト:https://apidog.com/jp/
Protoのインポート
gRPCは、API中心のテクノロジーなので、開発に移る前に、.protoファイルを通じて、サービス、方法およびメッセージを定義する必要があります。そこで、Apidogを使用して、gRPCの単体テストを行う前に、APIの定義として.protoファイルをインポートする必要があります。
実行の方法
.protoファイルを使用して、 gRPCの方法を定義する場合、以下のように4つの方法が利用できます。
- Unary:一元実行
- Server Streaming:サーバーのストリーミング
- Client Streming:クライアントストリーミング
- Bidirectional Streaming:双方向ストリーミング
動的値の自動生成
Apidog は、.protoファイルの内容を識別できるので、「自動生成」をクリックして、送信メッセージを自動的に生成できます。また、動的値ボタンをクリックして、動的値を利用することもできます。
変数の使用
gRPCのメッセージとMetadataで、Apidogの変数を利用できます。
TLSをオンにする
gRPC APIは、TLSを通じて安全に接続することができます。
Apidogを使用すると、URLの前のプロトコルをクリックして、TLSの状態を快適に切り替えます。
また、URLに「grpcs://」を使用すると、ApidogはTLSをオンにします。それに対して、「grpc://」の場合は、TLSは無効になります。
サーバーのURLと環境の管理
Apidogに現在利用中のサーバーURLを環境に追加することができます。そして、環境やサーバーのURLを選択し、URLの設定を「デフォルトを継承」にすることで、すべての方法も同じなURLで単体テストを行うようになります。
Protoファイルの内容を確認
Apidogの左側にメニューツリーのProtoをクリックすると、Protoファイルのオリジナル内容を確認できます。
リクエストとレスポンスのパラメータを確認
gRPCはシーケンス化フォーマットとしてProtoBufを使用しています。これは、メッセージの送受信の際に、各メッセージがProtoBufフォーマットで転送されることを意味しています。ProtoBufは、他のテキストに基づくフォーマット(JSON,XML)とは異なり、バイナリ形式なので、人間がそれを読み書きしたりすることが難しくなります。そこで、ApidogでgRPC APIを呼び出す際には、すべてのメッセージをJSONフォーマットで作成したり、表示したりすることができます。
gRPCは、API中心のテクノロジーなので、開発に移る前に、.protoファイルを通じて、サービス、方法およびメッセージを定義する必要があります。そこで、Apidogを使用して、gRPCの単体テストを行う前に、APIの定義として.protoファイルをインポートする必要があります。
実行の方法
.protoファイルを使用して、 gRPCの方法を定義する場合、以下のように4つの方法が利用できます。
- Unary:一元実行
- Server Streaming:サーバーのストリーミング
- Client Streming:クライアントストリーミング
- Bidirectional Streaming:双方向ストリーミング
動的値の自動生成
Apidog は、.protoファイルの内容を識別できるので、「自動生成」をクリックして、送信メッセージを自動的に生成できます。また、動的値ボタンをクリックして、動的値を利用することもできます。
変数の使用
gRPCのメッセージとMetadataで、Apidogの変数を利用できます。
TLSをオンにする
gRPC APIは、TLSを通じて安全に接続することができます。
Apidogを使用すると、URLの前のプロトコルをクリックして、TLSの状態を快適に切り替えます。
また、URLに「grpcs://」を使用すると、ApidogはTLSをオンにします。それに対して、「grpc://」の場合は、TLSは無効になります。
サーバーのURLと環境の管理
Apidogに現在利用中のサーバーURLを環境に追加することができます。そして、環境やサーバーのURLを選択し、URLの設定を「デフォルトを継承」にすることで、すべての方法も同じなURLで単体テストを行うようになります。
Protoファイルの内容を確認
Apidogの左側にメニューツリーのProtoをクリックすると、Protoファイルのオリジナル内容を確認できます。
リクエストとレスポンスのパラメータを確認
gRPCはシーケンス化フォーマットとしてProtoBufを使用しています。これは、メッセージの送受信の際に、各メッセージがProtoBufフォーマットで転送されることを意味しています。ProtoBufは、他のテキストに基づくフォーマット(JSON,XML)とは異なり、バイナリ形式なので、人間がそれを読み書きしたりすることが難しくなります。そこで、ApidogでgRPC APIを呼び出す際には、すべてのメッセージをJSONフォーマットで作成したり、表示したりすることができます。