ベースマキナ ドキュメント

gRPC と連携する

gRPC のデータソースに接続する

1. 右上のメニューから「データソース」を選択する

2. 「データソースの追加」をクリックする

3. データソースの種類の中から「gRPC」を選択する

データソースの選択

4. データソースへの接続に必要な情報を入力して保存する

データソースの接続設定
  1. サービス情報取得のための設定を行なう

ベースマキナは、gRPCメソッドの一覧を取得するためにステップ4で選択したサービス情報の取得先を使用します。

サービス情報の取得先

リフレクションを選択した場合

gRPCサーバーのリフレクションを有効化する必要があります。お手数ですがこちらの例などをご参考に有効化してください。

Protocol Buffers定義ファイルを選択した場合

gRPCサーバーのリフレクションの有効化は不要です。

代わりに、アクションの設定前にProtocol Buffers定義ファイルをAPI経由でアップロードしていただく必要があります。 詳しい方法についてはProtocol Buffers 定義ファイルの準備をご参照ください。

アップロードが完了すると、データソースの編集ページにて、利用するProtocol Buffers定義ファイルのバージョンを指定できるようになります。

gRPCアクション

gRPC をアクションで利用する

1. 右上のメニューから「アクション」を選択する

2. 「アクションの追加」をクリックする

3. アクション名やパラメーターを設定する

データソースの選択
  1. リクエスト方法を登録する

APIに対してのリクエスト内容を入力してください。

この時選べるメソッドの候補には、「gRPCのデータソースに接続する」の5で有効化したServer Reflection経由で取得されたメソッドの一覧が表示されます。

また、入力できるリクエストボディの値はJSONオブジェクトとして加工できます。

gRPCアクション