Postman 使用 gRPC 示例

2023-04-04 10:13 更新

您可以保存、編輯和共享 gRPC 請(qǐng)求-響應(yīng)對(duì)作為示例。您甚至可以從頭開始創(chuàng)建 gRPC 示例。

API 可能很復(fù)雜,使用它們的指南也可能很復(fù)雜。示例通過在單個(gè)可視快照中捕獲從客戶端發(fā)送的請(qǐng)求和從服務(wù)器接收的響應(yīng)來幫助您理解 API。您可以將這些快照組合在一個(gè)請(qǐng)求中,并將請(qǐng)求存儲(chǔ)在一個(gè)集合中,以說明 API 在不同場景下的功能。示例幫助 API 生產(chǎn)者漂亮地告訴世界他們的 API 是關(guān)于什么的。

保存 gRPC 示例

本演練創(chuàng)建并執(zhí)行一元請(qǐng)求,然后將響應(yīng)保存為 gRPC 示例。

如果您使用的是 Postman Web 應(yīng)用程序,則必須使用 Postman Desktop Agent。有關(guān)詳細(xì)信息,請(qǐng)參閱關(guān)于 Postman 代理。
  1. 在 Postman 中,選擇 新建 > gRPC 請(qǐng)求以在新選項(xiàng)卡中打開請(qǐng)求。
  2. 選擇輸入服務(wù)器 URL并輸入grpc.postman-echo.com。
  3. 選擇選擇方法下拉列表。加載方法列表后,選擇SayHello。新的 gRPC 請(qǐng)求
  4. 將 gRPC 請(qǐng)求保存到集合中。gRPC 請(qǐng)求除非請(qǐng)求在集合中,否則無法保存 gRPC 示例。
  5. 選擇調(diào)用。reply響應(yīng)部分中會(huì)出現(xiàn)一條消息。
  6. 選擇另存為示例。gRPC 保存示例按鈕保存的示例在新選項(xiàng)卡中打開,您可以在側(cè)邊欄的請(qǐng)求下看到保存的示例。gRPC 示例

編輯 gRPC 示例

本演練編輯了一個(gè) gRPC 示例。

  1. 創(chuàng)建一個(gè)一元 gRPC 請(qǐng)求,將其保存在一個(gè)集合中,并保存一個(gè) gRPC 示例。
  2. 在邊欄中選擇 gRPC 示例。選擇一個(gè) gRPC 示例
  3. 在響應(yīng)部分,選擇Status code下拉列表并選擇2 UNKNOWN。狀態(tài)代碼根據(jù) protobuf 模式自動(dòng)填充。選擇狀態(tài)碼響應(yīng)會(huì)自動(dòng)更新。狀態(tài)代碼 2 未知
  4. 選擇保存。

從頭開始創(chuàng)建 gRPC 示例

本演練使用流式方法創(chuàng)建 gRPC 示例。請(qǐng)注意流式方法消息與一元方法消息有何不同。

  1. 使用方法(或任何流方法)創(chuàng)建 gRPC 請(qǐng)求LotsOfReplies并將其保存在集合中。
  2. 將鼠標(biāo)懸停在您創(chuàng)建的 gRPC 請(qǐng)求上,然后選擇更多操作圖標(biāo) 更多操作圖標(biāo) 。
  3. 選擇添加示例。選擇添加示例
  4. 一個(gè)空示例在工作臺(tái)中打開,并顯示在側(cè)邊欄中請(qǐng)求的下方。 新例子
  5. 選擇Add a Message下拉菜單并選擇Message stream。選擇消息流這會(huì)使用 protobuf 架構(gòu)中定義的消息結(jié)構(gòu)自動(dòng)創(chuàng)建示例消息流。示例消息流
  6. 選擇保存。

創(chuàng)建特定于示例的文檔

  1. 創(chuàng)建一個(gè) gRPC 請(qǐng)求,將其保存在一個(gè)集合中,并保存一個(gè) gRPC 示例。
  2. 在邊欄中選擇 gRPC 示例。選擇保存的示例
  3. 在右側(cè)邊欄中,選擇文檔圖標(biāo) 文檔圖標(biāo) 。
  4. 將鼠標(biāo)懸停在添加示例描述... 上,然后選擇編輯圖標(biāo) 編輯圖標(biāo) 。選擇編輯圖標(biāo)
  5. 輸入 gRPC 示例的文檔并選擇Save。保存文檔

使用已保存示例中的消息

在調(diào)用請(qǐng)求時(shí),您可以使用示例中存儲(chǔ)的消息有效負(fù)載。這不僅可以讓您自己測試示例場景,還可以加快您的調(diào)試工作流程。

本演練展示了如何使用示例中存儲(chǔ)的消息調(diào)用客戶端流請(qǐng)求:

  1. 使用該方法創(chuàng)建一個(gè) gRPC 請(qǐng)求LotsOfGreetings,并將其保存在一個(gè)集合中。
  2. 使用兩個(gè)不同的消息為請(qǐng)求創(chuàng)建一個(gè)示例"greeting"。創(chuàng)建示例
  3. 選擇請(qǐng)求并選擇Invoke。
  4. 選擇使用示例消息旁邊的下拉列表。出現(xiàn)示例中的兩條消息。示例消息
  5. 從下拉列表中選擇一條消息,然后選擇發(fā)送。
  6. 再次打開下拉菜單并選擇不同的消息。


以上內(nèi)容是否對(duì)您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號(hào)
微信公眾號(hào)

編程獅公眾號(hào)