Scripting (глазами разработчика)
Скрипты перед отправкой / после ответа — швейцарский нож Quick Request: динамическая подпись, шифрование и расшифровка, условные проверки и передача значений между запросами живут здесь. Скрипты пишутся на JavaScript и выполняются во встроенном движке QuickJS.
Эта страница покры вает только что можно добавить в UI и что могут скрипты; полные сигнатуры JavaScript API смотрите в Справочнике API скриптов.
У одного запроса две «цепочки действий»
На странице редактора запроса можно добавить несколько шагов в цепочки перед отправкой и после ответа; они выполняются по порядку. Каждый шаг — один из типов:
| Тип шага | Что вы делаете в UI | Типичное применение |
|---|---|---|
| Скрипт | Пишете фрагмент JavaScript | Изменение headers/body, подпись, расшифровка, условная логика |
| Библиотечный скрипт | Ссылаетесь на сохраненный общий скрипт | Переиспользование «внедрения токена», «единого логирования» во многих местах |
| Извлечение | Берете значение из ответа и сохраняете как переменную | Передать токен в хода следующему запросу |
| Проверка | Добавляете одну валидацию к ответу | Код состояния = 200, поле существует |
| Ожидание | Пауза на несколько миллисекунд | Rate limiting, интервалы опроса |
Как писать скрипты: две точки входа
Движок скриптов ищет в вашем скрипте известные функции входа:
// Pre-send: can change "the request that is about to go out"
async function onRequest(context, url, request) {
// e.g. inject a header
request.headers.set('X-Trace-Id', $uuid.v4());
return request; // you must return the request
}
// Post-response: can read and change "the response you received"
async function onResponse(context, url, response) {
// e.g. rewrite an encrypted response back to plaintext for humans
return response;
}
onRequestпишите в цепочке перед отправкой,onResponse— в цепочке после ответа.- Имена функций должны быть ровно такими, иначе скрипт считается «без точки входа» и пропускается.
awaitподдерживается.
Что могут менять скрипты
Изменение запроса (объект request в onRequest)
| Вы хотите | Как |
|---|---|
| Задать / переопределить заголовок | request.headers.set('Authorization', 'Bearer ' + tok) |
| Добавить / изменить query-параметр | request.queries.set('ts', String(Date.now())) |
| Прочитать сырое тело | var text = request.body.parseText() или request.body.parseJSON() |
| Переписать все тело | request.body = the new string (простое присваивание) |
Чтение / изменение ответа (объект response в onResponse)
| Вы хотите | Как |
|---|---|
| Прочитать код состояния | response.statusCode |
| Прочитать заголовок ответа | response.headers.get('Set-Cookie') |
| Прочитать тело | response.body.parseJSON() / .parseText() |
| Переписать все тело ответа | response.body = the new string — UI/результат показывает переписанный контент (проверено) |