gRPC 是一個高效、快速且可靠的遠端程序呼叫(RPC)框架,廣泛用於各種情境。在微服務架構中,Apidog 有助於服務之間的高效通訊。對於涉及大量資料傳輸的情境,Apidog 會利用串流能力來降低網路延遲與頻寬消耗。gRPC API 偵錯功能目前處於 Beta 測試階段。Apidog 版本必須等於或高於 2.3.0,才能使用 gRPC API 偵錯功能。
建立新的 gRPC 專案#
在 Apidog 首頁點擊「New Project」按鈕,並選擇「gRPC Project (Beta)」。匯入 Proto#
gRPC 採用 API-First 方法,這表示在開發之前,必須透過 .proto 檔案定義服務、方法與訊息。因此,在使用 Apidog 偵錯 gRPC API 之前,你需要匯入作為 API 定義的 .proto 檔案。初次匯入#
選取的 .proto 檔案將作為一個 Proto 匯入,其中 service 會匯入為服務,rpc 會匯入為方法。如果選取的 .proto 檔案依賴其他 .proto 檔案,你需要手動新增依賴目錄。若選取的 .proto 檔案所依賴的其他 .proto 檔案中的服務,其 package 與選取的 .proto 檔案屬於相同 package,這些服務也會被匯入到同一個 Proto 中。重新匯入#
如果已匯入的 .proto 檔案發生變更,可以在 Apidog 中重新匯入:在 Proto 上按右鍵,然後點擊「Reimport」按鈕。呼叫方法#
使用 .proto 檔案定義 gRPC 方法時,Apidog 支援四種類型:Bidirectional Streaming:雙向串流
Unary 呼叫#
Unary 呼叫類似於 HTTP 請求。在地址列中輸入 URL,在 Message 分頁下以 JSON 格式輸入訊息內容,點擊「Invoke」按鈕,即會發起 unary 呼叫。此外,你可以手動填寫 Metadata 與 Auth 資訊,以滿足驗證或其他複雜情境。串流呼叫#
串流呼叫類似於 WebSocket 連線。發起呼叫後,你可以在 Message 分頁下撰寫並傳送訊息。伺服器端串流、用戶端串流與雙向串流都屬於串流呼叫類型。Apidog 提供時間軸檢視,可依時間順序集中顯示呼叫狀態、已傳送訊息與已接收訊息。點擊訊息即可輕鬆查看訊息詳細資料。進階用法#
自動產生動態值#
Apidog 可以識別 .proto 檔案中的內容,讓你點擊「Auto-generate」按鈕來產生訊息主體。若需要更彈性的動態資料,你可以使用「Dynamic Values」功能來設定並產生運算式。使用變數#
啟用 TLS#
gRPC API 支援透過 TLS 建立 安全連線。使用 Apidog 時,你可以點擊 URL 前方的通訊協定選擇器,快速切換 TLS 狀態。此外,Apidog 相容於在 URL 中使用 grpcs:// 來為連線啟用 TLS。相反地,grpc:// 表示未啟用 TLS。管理伺服器地址與環境#
點擊 URL 地址列右側的加號圖示,將目前使用的伺服器地址新增到環境中。接著,在右上角選擇環境與伺服器地址,並在 URL 地址列中選擇「Follow Default」,即可使用統一的伺服器地址來偵錯所有方法。查看 Proto 檔案與 API 參數#
查看 Proto 檔案內容