Apidog Docs
🇨🇳 简体中文
  • 🇺🇸 English
  • 🇯🇵 日本語
  • 🇪🇸 Español
  • 🇰🇷 한국인
  • 🇨🇳 简体中文
  • 🇵🇹 Português (Portugal)
  • 🇮🇩 Bahasa Indonesia
  • 🇧🇷 Português (Brasil)
  • 🇻🇳 Tiếng Việt
  • 🇨🇳 繁體中文
🇨🇳 简体中文
  • 🇺🇸 English
  • 🇯🇵 日本語
  • 🇪🇸 Español
  • 🇰🇷 한국인
  • 🇨🇳 简体中文
  • 🇵🇹 Português (Portugal)
  • 🇮🇩 Bahasa Indonesia
  • 🇧🇷 Português (Brasil)
  • 🇻🇳 Tiếng Việt
  • 🇨🇳 繁體中文
🇨🇳 简体中文
  • 🇺🇸 English
  • 🇯🇵 日本語
  • 🇪🇸 Español
  • 🇰🇷 한국인
  • 🇨🇳 简体中文
  • 🇵🇹 Português (Portugal)
  • 🇮🇩 Bahasa Indonesia
  • 🇧🇷 Português (Brasil)
  • 🇻🇳 Tiếng Việt
  • 🇨🇳 繁體中文
HomeLearning Center
Support CenterAPI ReferencesDownloadChangelog
HomeLearning Center
Support CenterAPI ReferencesDownloadChangelog
  1. 发送请求
  • Back to home
  • 支持中心
  • Apidog 支持中心
  • 导入/导出
    • 如何将 API 数据导入 Apidog？
    • 如何在 Apidog 中导入 cURL？
    • 如何将 Postman 环境迁移到 Apidog？
    • 如何在导入 Swagger/OpenAPI 时自动对端点分组？
  • 发送请求
    • Apidog 支持 Socket.IO 吗？
    • 为什么参数值中的 “+” 会被解码为空格？
    • 如何在 Apidog 中发送请求？
    • 如何在 Apidog 中发送 graphQL 请求？
    • 如何在 Apidog 中发送 gRPC 请求？
    • 如何在 Apidog 中发送 SOAP/WebService 请求？
    • 如何在 Apidog 中发送 WebSocket 请求？
    • Apidog 是否支持 WebSocket API 中的预请求/测试脚本和断言？
    • 如何在 Apidog 中发送 SSE 请求？
    • 如何在文件夹级别添加默认头部？
    • Apidog 是否支持 gRPC API 中的预请求/测试脚本和断言？
    • ELANREFUSED.DNS 解析器错误
    • 为什么我在发送请求时会收到 “socket hang up” 错误？
    • 修复请求错误
      • 修复 read ECONNRESET 错误
      • 修复 ECONNREFUSED 错误
      • 修复 ETIMEDOUT 错误
      • 修复 ENOTFOUND: Couldn't resolve host 错误
      • 修复 ENOTFOUND: getaddrinfo ENOTFOUND www 错误
      • 修复 connect EHOSTUNREACH 错误
  • 设计 API
    • 如何在路径中使用变量？
    • 我可以将响应组件用作默认响应吗？
    • 如何查看谁修改了端点？
    • 如何在 Apidog 中批量删除端点文件夹？
    • 如何批量为端点路径添加/移除前缀？
    • 如何在 Schema 编辑器中移动属性的层级？
    • 如果一个字符串属性有多个枚举值，并且会在多个位置使用，如何在整个文档中一致地引用这个枚举？
    • 如何获取 Apidog 资源文件夹 ID？
    • 如何获取 Apidog 的资源文件夹 ID？
    • 如何在 URL 路径中使用变量？
    • 如果端点、文档或测试场景被意外删除，我该怎么办？
    • Apidog 是否支持自定义端点的请求代码？
    • 将 Swagger/OpenAPI 导入 Apidog 时，如何自动对端点分组？
    • 如何在模拟响应中生成不重复的数组数据？
    • 为什么路径中不支持输入 "#"？
  • 调试 API
    • Apidog 如何与第三方密钥管理系统集成？
    • 为什么同一个请求在其他工具（如 Postman）中可以正常工作，但在 Apidog 中不行？
    • 如何在 Apidog 中从数据库获取变量值？
    • 如何将环境从其他工具迁移到 Apidog？
    • 如何在 Apidog 中使用脚本进行断言？
    • JSONPath 只能提取数组。如何在 Apidog 中从数组中提取单个元素？
    • 当不同环境具有不同的数据库账号凭据时，如何在 Apidog 中配置数据库操作？
    • 如何在自定义脚本中获取服务基础 URL？
    • 当 API 响应过大时，为什么 Apidog 会报告超出最大 Node.js 字符串长度的错误？
    • 控制台打印的大小限制是多少？为什么打印大文件时会出现错误？
    • 如何解决 Windows 上的 DB2 数据库连接错误？
    • 为什么我在 Apidog 中连接 Oracle 数据库时会遇到错误 NJS-045？
    • 如何在 Apidog 自定义脚本中生成动态值？
    • 为什么客户端请求同一个端点可以成功，但在 Web 端调试时却出现错误：“Unable to request address”？
    • 为什么响应过大时 Apidog 会报错？
    • 如何使用 Apidog 录制端点？
    • 定义端点响应时，是否允许端点没有响应内容？
    • 如何在自定义脚本中获取服务的 baseURL？
    • 如何在 Apidog 中查看原始报文？
    • 为什么在发起请求时会看到 “Invalid URI xxx” 错误？
    • 如何在 Apidog 脚本中发起异步请求？
    • 为什么发送请求时会看到 “Couldn't resolve host” 消息？
    • 控制台打印大小限制是多少？为什么打印大文件时会报错？
    • 如何在端点请求中上传文件？
    • 如果 Apidog 崩溃或响应数据不显示，该怎么办？
    • Apidog 用于 OAuth2.0 的官方重定向 URI
  • Mock API 数据
    • 如何自动模拟 API？
    • Apidog 模拟可以做什么？
    • 如何在 Apidog 中模拟固定 API 数据？
    • 如何在 Apidog 中模拟条件数据？
    • 如何在 Apidog 中启用云端模拟？
    • 如何在 Apidog 中启用自托管模拟？
    • Apidog 支持模拟 WebSocket API 吗？
    • 为什么浏览器请求模拟端点时不返回内容？
  • 自动化测试
    • 为什么测试场景在我的本地客户端运行没有问题，但在 Apidog CLI 或运行器中运行时会出错？
    • 如何在 Apidog 中创建测试场景？
    • 如何在测试步骤之间传递数据？
    • 为什么我无法成功引用前置步骤数据？
    • 如何在 Apidog 中使用 foreach 循环？
    • 从端点/端点用例同步数据有哪些区别？
    • 如何在 Apidog 中使用测试数据？
    • 如何在 Apidog 的脚本中检索测试数据？
    • 如何在 Apidog 中批量运行测试场景？
    • 如何在 Apidog 中安排测试任务？
    • 如何在 Apidog 中运行性能测试？
    • 如何在性能测试中查看实际请求和响应？
    • 如何在 Apidog 中导出性能测试报告？
    • 如何使用数据库查询结果作为循环 API 请求的参数？
    • 在 CI/CD 期间使用 ApiDog 捕获并验证 Stripe Webhook
    • 如何解决“Error: unable to verify the first certificate on runner”错误？
    • General Runner Docker 容器 “Not Found” 错误。
    • 如何在 Apidog Web 版中为通用 Runner 设置服务器 Host？
    • 为什么定时测试场景最终显示 0 个请求？
    • 如果在 Runner 或 CLI 中找不到文件上传参数，我该怎么办？
    • 如何使用 Runner 运行包含上传文件步骤的测试场景？
    • 如何解决“Error: unable to verify the first certificate on runner”错误？
    • 当 Runner 出现问题时，如何访问和搜索 Runner 日志以识别问题？
    • 如果端点参数是上传文件，并且在 Runner 或 CLI 中找不到，我该怎么办？
    • 为什么 API 用例变更时测试步骤不会自动同步？
    • 为什么在 Markdown 文档中使用多个美元符号会导致某些内容无法正确显示？
    • 自托管 Runner 在执行任务后会在服务器上生成测试报告吗？
    • 我可以为测试场景中的请求添加统一的前置/后置处理器吗？
    • 如何在单次自动化测试运行期间保持动态值一致？
  • 发布 API 文档
    • 如何在已发布的文档中隐藏所有 Apidog 标志？
    • 当 API 规范更新时，API 文档会变化吗？
    • 如何在 Apidog 中将 API 分享给协作者？
    • 如何自定义 Apidog 文档的域名？
    • 如何在 Apidog 中创建多版本文档？
    • Apidog 中发布文档站点的共享范围
    • Apidog 中 Share Doc 列表的共享范围
    • 为什么已发布的共享文档没有显示主机名？
    • 文档用户如何在共享文档中修改 Base URL？
    • 我可以复制已发布的 Apidog 文档用于自己的项目吗？
    • 如何在 Apidog 在线文档中共享头部（例如 Token）？
    • 为什么我的团队成员找不到已发布的文档？
    • 如何修复自定义域名上的 SSL 证书过期或 Cloudflare 526 错误？
    • 自定义 SMTP 配置成功，但允许列表用户未收到 OTP 邮件
  • Markdown
    • 如何使用卡片链接到 Apidog 内的各个页面或端点？
    • 为什么在 Markdown 文档中使用多个 $ 符号时，部分内容无法正确显示？
    • 如何在 Apidog Markdown 中使用透明背景图片？
    • 如何设置 Markdown 表格的列宽？
    • 如何将内部 API、文档、数据模式或文件夹插入到 Markdown 文档中？
    • 如何在 Apidog 卡片组件中添加指向项目内文档或端点的链接？
  • 分支
    • 如何访问迭代分支？
  • 管理
    • 如何静默安装 Apidog 客户端？
    • 为什么我明明拥有管理员权限，却看到“No Permission”错误？
    • 如何查看 Runner 版本号？
    • Apidog 支持 win7 吗？
    • 为什么安装后 Apidog 显示错误“Cannot locate program entry point DiscardVirtualMemory in dynamic link library KERNEL32.dll”？
    • 订阅变更和退款
    • Web 请求有效，但应用出现 “read ECONNRESET”——为什么？
    • Windows 系统更新后为什么无法打开 Apidog？
    • 为什么 Windows 系统更新后 Apidog 无法打开
  • 计费
    • 我可以在 Apidog 中为我的团队设置单独的账单账户吗？
    • Apidog 上的团队访问与计费问题
    • 受邀团队成员无法访问 Apidog。
    • 将个人付费团队转移到组织
  • 私有化部署
    • Apidog 自托管（企业）版本中的用户和访问管理
  • Web 与客户端
    • Linux 桌面版的下载与安装
  1. 发送请求

如何在 Apidog 中发送 gRPC 请求？

gRPC 是一种高效、快速且可靠的远程过程调用（RPC）框架，广泛用于各种场景。在微服务架构中，Apidog 可促进服务之间的高效通信。对于涉及大量数据传输的场景，Apidog 利用流式传输能力来降低网络延迟和带宽消耗。
gRPC API 调试功能目前处于 Beta 测试阶段。要使用 gRPC API 调试功能，Apidog 版本必须等于或高于 2.3.0。

创建新的 gRPC 项目#

点击 Apidog 首页上的“新建项目”按钮，并选择“gRPC Project (Beta)”。

导入 Proto#

gRPC 遵循 API-First 方法，这意味着在开发之前，必须通过 .proto 文件定义服务、方法和消息。因此，在使用 Apidog 调试 gRPC API 之前，你需要导入作为 API 定义的 .proto 文件。

初始导入#

目前，有两种方式可以导入 .proto 文件：
本地文件
托管 .proto 文件的 URL
所选的 .proto 文件将作为一个 Proto 导入，其中 service 会作为服务导入，rpc 会作为方法导入。
如果所选的 .proto 文件依赖其他 .proto 文件，你需要手动添加依赖目录。
如果所选 .proto 文件依赖的其他 .proto 文件中的服务与所选 .proto 文件属于同一个 package，这些服务也会被导入到同一个 Proto 中。

重新导入#

如果已导入的 .proto 文件发生更改，可以在 Apidog 中重新导入：右键点击 Proto，然后点击“重新导入”按钮。

调用方法#

使用 .proto 文件定义 gRPC 方法时，Apidog 支持四种类型：
Unary：一元调用
Server Streaming：服务端流式传输
Client Streaming：客户端流式传输
Bidirectional Streaming：双向流式传输
Apidog 支持全部四种方法类型。

一元调用#

一元调用类似于 HTTP 请求。在地址栏中输入 URL，在 Message 选项卡下以 JSON 格式输入消息内容，点击“Invoke”按钮，即可发起一元调用。
此外，你可以手动填写 Metadata 和 Auth 信息，以满足身份验证或其他复杂场景的需求。

流式调用#

流式调用类似于 WebSocket 连接。发起调用后，你可以在 Message 选项卡下编写并发送消息。服务端流式传输、客户端流式传输和双向流式传输都属于流式调用类型。
Apidog 提供时间线视图，按时间顺序集中显示调用状态、已发送消息和已接收消息。点击某条消息即可方便地查看消息详情。

高级用法#

自动生成动态值#

Apidog 可以识别 .proto 文件中的内容，使你能够点击“Auto-generate”按钮来生成消息主体。对于更灵活的动态数据，你可以使用“Dynamic Values”功能配置并生成表达式。
有关更详细的说明，请参阅 “Dynamic Values”。

使用变量#

你可以在 gRPC 消息和 Metadata 中使用 Apidog 变量。有关详细说明，请参阅 “Environment Variable Types” 文档。

启用 TLS#

gRPC API 支持通过 TLS 建立安全连接。
使用 Apidog 时，你可以点击 URL 前面的协议选择器，快速切换 TLS 状态。
此外，Apidog 兼容在 URL 中使用 grpcs:// 来为连接启用 TLS。相反，grpc:// 表示未启用 TLS。

管理服务器地址和环境#

点击 URL 地址栏右侧的加号图标，将当前使用的服务器地址添加到环境中。
然后，在右上角选择环境和服务器地址，并在 URL 地址栏中选择“Follow Default”，即可使用统一的服务器地址调试所有方法。

查看 Proto 文件和 API 参数#

查看 Proto 文件内容#

在 Apidog 中，点击左侧目录树中的 Proto，即可查看 .proto 文件的原始内容。

查看请求和响应参数#

gRPC 使用 ProtoBuf 作为序列化格式，这意味着发送或接收消息时，每条消息都以 ProtoBuf 格式传输。与其他基于文本的序列化格式（JSON、XML）不同，ProtoBuf 是二进制格式，不适合人工编写和阅读。因此，在 Apidog 中调用 gRPC API 时，所有消息都以 JSON 格式编写和显示。
你可以在 API 信息页面查看以 JSON 格式表示的请求和响应参数。
ProtoBuf 和 JSON 的数据类型存在映射关系，如下表所示：
ProtoBuf 3JSONJSON 示例
messageobject{"fooBar": v, "g": null, …}
enumstring"FOO_BAR"
map<K,V>object{"k": v, …}
repeated Varray[v, …]
boolbooleantrue, false
stringstring"Hello World!"
bytesbase64 string"YWJjMTIzIT8kKiYoKSctPUB+"
int32, fixed32, uint32number1, -10, 0
int64, fixed64, uint64string"1", "-10"
float, doublenumber1.1, -10.0, 0, "NaN", "Infinity"

保存调试信息#

完成调试后，点击“Save”按钮，将当前方法中的服务器 URL、消息、Metadata 等保存下来，以便其他团队成员进行调试。
Modified at 2026-06-09 08:55:47
Previous
如何在 Apidog 中发送 graphQL 请求？
Next
如何在 Apidog 中发送 SOAP/WebService 请求？
Built with