跳到主要内容

使用 gRPC 示例

你可以保存、编辑和共享 gRPC 请求-响应对作为 示例 。你甚至可以从头开始创建 gRPC 示例。

API 可能很复杂，使用它们的指南也可能很复杂。示例通过在单个可视快照中捕获从客户端发送的请求和从服务器接收的响应来帮助你理解 API。你可以将这些快照组合在一个请求中，并将请求存储在一个集合中，以说明 API 在不同场景下的功能。示例帮助 API 生产者漂亮地告诉世界他们的 API 是关于什么的。

保存 gRPC 示例​

本演练创建并执行一元请求，然后将响应保存为 gRPC 示例。

如果你使用的是 Postman Web 应用程序，则必须使用 Postman Desktop Agent。有关详细信息，请参阅 关于 Postman 代理。

  1. 在 Postman 中，选择 “新建”>“gRPC”以在新选项卡中打开请求。

  2. 选择输入服务器 URL并输入grpc.postman-echo.com。

  3. 选择选择方法下拉列表。加载方法列表后，选择SayHello。

    新的 gRPC 请求

  4. 将 gRPC 请求保存到集合中。

    除非请求在集合中，否则无法保存 gRPC 示例。

  5. 选择调用。reply响应部分中会出现一条消息。

  6. 选择另存为示例。保存的示例在新选项卡中打开，你可以在侧边栏的请求下看到保存的示例。

    gRPC 保存示例按钮

编辑 gRPC 示例​

本演练编辑了一个 gRPC 示例。

  1. 创建一个一元 gRPC 请求，将其保存在一个集合中，并保存一个 gRPC 示例。

  2. 在边栏中选择 gRPC 示例。

  3. 在响应部分，选择Status code下拉列表并选择2 UNKNOWN。响应会自动更新。

    状态代码根据 protobuf 模式自动填充。

    选择状态码

  4. 选择保存。

从头开始创建 gRPC 示例​

本演练使用流式方法创建 gRPC 示例。请注意流式方法消息与一元方法消息有何不同。

  1. 使用方法（或任何流方法）创建 gRPC 请求LotsOfReplies并将其保存在集合中。

  2. 将鼠标悬停在你创建的 gRPC 请求上，然后选择更多操作图标 更多操作图标 >添加示例。一个空示例在工作台中打开，并显示在侧边栏中请求的下方。

  3. 选择Add a Message下拉菜单并选择Message stream。这会使用 protobuf 架构中定义的消息结构自动创建示例消息流。

    选择消息流

  4. 选择保存。

创建特定于示例的文档​

  1. 创建一个 gRPC 请求，将其保存在一个集合中，并保存一个 gRPC 示例。
  2. 在边栏中选择 gRPC 示例。
  3. 在右侧边栏中，选择文档图标 文档图标 。
  4. 选择添加示例说明。
  5. 输入 gRPC 示例的文档。你的文档会自动保存。

使用已保存示例中的消息​

在调用请求时，你可以使用示例中存储的消息有效负载。这不仅可以让你自己测试示例场景，还可以加快你的调试工作流程。

本演练展示了如何使用示例中存储的消息调用客户端流请求：

  1. 使用该方法创建一个 gRPC 请求LotsOfGreetings，并将其保存在一个集合中。

  2. 使用两个不同的消息 为请求创建一个示例 "greeting"。

    创建示例

  3. 选择请求并选择Invoke。

  4. 选择使用示例消息旁边的下拉列表。出现示例中的两条消息。

    示例消息

  5. 从下拉列表中选择一条消息，然后选择发送。

  6. 再次打开下拉菜单并选择不同的消息。