Перейти до вмісту

Вбудовані змінні в полях

Будь-яке текстове поле запиту приймає вираз 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

Перегляд обчисленого значення

Section titled “Перегляд обчисленого значення”

Під відповідними полями Restorm показує обчислене значення з активним середовищем. Це той рефлекс, який варто виробити, перш ніж дивуватися, чому виклик іде на неправильний URL: відповідь майже завжди видно саме там.

Поле URL зі вмістом {{baseUrl}}/pet/{{petId}} і його значенням, обчисленим за активним середовищем, показаним просто під полем

Ctrl+Space викликає автодоповнення в полях, які його підтримують: воно пропонує змінні поточного середовища та помічників Handlebars із їхнім підписом і прикладом.

  • Необчислений вираз (неіснуюча змінна) дає порожній рядок — помилки він не спричиняє. Звідси й важливість попереднього перегляду.
  • Шаблон компілюється без екранування HTML: & чи < у значенні проходить незмінним, і саме такої поведінки очікують для JSON або XML.
  • Помічники без аргументів ({{uuid}}, {{now}}, {{$randomEmail}}…) дають інше значення під час кожного надсилання. Так і задумано, і це зручно для ідентифікаторів кореляції.

Повний довідник: Помічники Handlebars.