跳转到内容

字段中的内联变量

请求的任何文本字段都接受内联书写的 Handlebars 表达式。这是给一次调用加参数的 最直接方式:无需任何预先配置,替换会在发送的那一刻完成。

  • URL(包括协议、主机、端口和查询字符串);
  • 请求头,键和值都可以;
  • 查询参数路径参数
  • 正文:原始 JSON、XML、表单、x-www-form-urlencoded
  • 各协议专属的字段:MQTT 主题、AMQP 路由键、gRPC 消息、GraphQL 查询及其变量、 Redis 命令、Kafka 键……

一个完全参数化的 URL:

{{scheme}}://{{host}}:{{port}}/v{{apiVersion}}/clients/{{clientId}}

一个由多部分拼成的请求头:

Authorization: Bearer {{accessToken}}
X-Request-Id: {{uuid}}

一个混用变量和辅助函数的 JSON 正文:

{
"reference": "CMD-{{timestamp}}",
"client": "{{clientId}}",
"libelle": "{{uppercase produit}}",
"montant": {{multiply prixUnitaire quantite}},
"creeLe": "{{now}}"
}

一个 MQTT 主题和一个 AMQP 路由键:

capteurs/{{site}}/{{capteurId}}/mesures
commandes.{{pays}}.creees

在相关字段的下方,Restorm 会显示按当前生效环境解析后的值。 在纳闷某个调用为什么发往了错误的 URL 之前,先看这里应该成为习惯: 答案几乎总是就摆在那儿。

一个内容为 {{baseUrl}}/pet/{{petId}} 的 URL 字段,其下方显示了按当前生效环境解析出的值

在支持的字段中按 Ctrl+Space 可触发自动补全:它会同时列出当前环境的变量 Handlebars 辅助函数,并附上它们的签名和一个示例。

  • 未能解析的表达式(变量不存在)会渲染成空字符串 —— 它不会引发错误。 这正是预览如此重要的原因。
  • 模板编译时不做 HTML 转义:值中的 &< 会原样通过, 这对 JSON 或 XML 来说正是期望的行为。
  • 无参数的辅助函数({{uuid}}{{now}}{{$randomEmail}}……) 每次发送都会产生不同的值。这是刻意的,而且对关联标识很有用。

完整参考:Handlebars 辅助函数