मुख्य कंटेंट तक स्किप करें

Scripting (डेवलपर व्यू)

प्री-सेंड / पोस्ट-रिस्पॉन्स स्क्रिप्ट Quick Request का स्विस आर्मी नाइफ है: डायनामिक साइनिंग, एन्क्रिप्शन और डिक्रिप्शन, कंडीशनल assertions और क्रॉस-रिक्वेस्ट मान पासिंग यहीं रहते हैं। स्क्रिप्ट JavaScript में लिखी जाती हैं और बिल्ट-इन QuickJS इंजन में चलती हैं।

यह पेज केवल UI में क्या जोड़ सकते हैं और स्क्रिप्ट क्या कर सकते हैं कवर करता है; पूरे JavaScript API सिग्नेचर के लिए Script API Reference देखें।


एक रिक्वेस्ट में दो "एक्शन चेन"​

रिक्वेस्ट एडिटर पेज पर आप प्री-सेंड और पोस्ट-रिस्पॉन्स चेन में कई चरण जोड़ सकते हैं; वे क्रम में चलते हैं। हर चरण इनमें से एक है:

चरण प्रकारUI में क्या करते हैंआम उपयोग
स्क्रिप्टएक टुकड़ा JavaScript लिखते हैंहेडर/बॉडी बदलना, साइनिंग, डिक्रिप्शन, कंडीशनल लॉजिक
लाइब्रेरी स्क्रिप्टसेव किए गए साझा स्क्रिप्ट का संदर्भ"टोकन इंजेक्ट", "एकीकृत लॉगिंग" कई जगह पुनः उपयोग
एक्सट्रैक्टरिस्पॉन्स से मान लेकर वेरिएबल सेवलॉगिन टोकन अगली रिक्वेस्ट को पास
Assertरिस्पॉन्स पर एक सत्यापन जोड़ते हैंस्टेटस कोड = 200, फ़ील्ड मौजूद
प्रतीक्षाकुछ मिलीसेकंड रुकेंरेट लिमिटिंग, पोलिंग अंतराल

स्क्रिप्ट कैसे लिखें: दो एंट्री पॉइंट​

स्क्रिप्ट इंजन आपकी स्क्रिप्ट में जाने-माने एंट्री फ़ंक्शन ढूँढता है:

// 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 लिखें।
  • फ़ंक्शन नाम बिल्कुल यही होने चाहिए, वरना स्क्रिप्ट "no entry point" मानी जाकर छोड़ दी जाती है।
  • await समर्थित है।

स्क्रिप्ट क्या बदल सकते हैं​

रिक्वेस्ट बदलना (onRequest में request ऑब्जेक्ट)​

आप चाहते हैंकैसे
हेडर सेट / ओवरराइड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 (साधारण असाइनमेंट)

रिस्पॉन्स पढ़ना / बदलना (onResponse में response ऑब्जेक्ट)​

आप चाहते हैंकैसे
स्टेटस कोड पढ़ेंresponse.statusCode
रिस्पॉन्स हेडर पढ़ेंresponse.headers.get('Set-Cookie')
बॉडी पढ़ेंresponse.body.parseJSON() / .parseText()
पूरी रिस्पॉन्स बॉडी रीराइटresponse.body = the new string — UI/परिणाम व्यू रीराइट किया कंटेंट दिखाता है (सत्यापित)

बिल्ट-इन क्षमताएँ — दोबारा मत बनाएँ​

स्क्रिप्ट बिल्ट-इन टूल्स (sdk.*) और $-प्रीफ़िक्स नेटिव क्षमताओं के साथ आते हैं: एन्क्रिप्शन, डाइजेस्ट, एनकोडिंग, रैंडमनेस और JSONPath सब कवर:

क्षमताक्या उपयोग करें
वेरिएबल पढ़ें / लिखें (क्रॉस-रिक्वेस्ट पासिंग)sdk.env.get(name) / sdk.env.set(name, value)
घोषणात्मक टेस्टsdk.test('status should be 200', function(){ sdk.expect(response.statusCode).toBe(200) })
JSONPath क्वेरीsdk.jsonPath('$.data.id')
AES एन्क्रिप्शन / डिक्रिप्शन$crypto.encryptAES(plaintext, key[, iv]) / $crypto.decryptAES(ciphertext, key[, iv])
MD5 / SHA डाइजेस्ट (साइनिंग)$hash.md5(...) / $hash.sha256(...) (hex लौटाता है, मानक और इंटरऑपरेबल)
UUID$uuid.v4()
स्ट्रिंग base64sdk.utils.base64Encode(str) / base64Decode(str)

⚠️ इंजन QuickJS है: ब्राउज़र जैसा crypto.subtle नहीं है, और crypto.getRandomValues इस इंजन में काम नहीं करता (पास किया ऐरे भरता नहीं) — AES के लिए $crypto, रैंडमनेस के लिए crypto.randomUUID / $uuid उपयोग करें। WebCrypto तक न जाएँ। पूरे सिग्नेचर और सावधानियाँ: Script API Reference।


require() से स्क्रिप्ट लाइब्रेरी लोड करना​

साझा लॉजिक को चरण के रूप में जोड़ने की बजाय CommonJS-स्टाइल require() से भी लोड किया जा सकता है। की हमेशा @libs/<key>, इस क्रम में रिज़ॉल्व होती है:

  1. स्क्रिप्ट-लाइब्रेरी आइडेंटिफ़ायर — सटीक मेल, रिनेम पर स्थिर (अनुशंसित)
  2. स्क्रिप्ट-लाइब्रेरी नाम — पढ़ने योग्य, पर लाइब्रेरी रिनेम करने पर संदर्भ टूट जाता है (अस्पष्ट डुप्लिकेट नाम छोड़ दिए जाते हैं)
  3. बिल्ट-इन लाइब्रेरी — ऐप के साथ बंडल

बिल्ट-इन लाइब्रेरी​

कीएक्सपोर्टटिप्पणियाँ
@libs/base64encode(str) / decode(text)UTF-8-सुरक्षित Base64 (ग़ैर-ASCII और इमोजी सुरक्षित); decode व्हाइटस्पेस अनदेखा करता है, अमान्य सीक्वेंस Latin-1 के रूप में रखता है
@libs/hexencode(str) / decode(text)UTF-8-सुरक्षित लोअरकेस hex; decode ग़ैर-hex अक्षर अनदेखा, विषम लंबाई पर थ्रो

दोनों ग्लोबल एलियास के रूप में भी उपलब्ध (base64.encode(...) / hex.encode(...)) — require बस स्पष्ट इंपोर्ट स्टाइल देता है।

const { encode } = require('@libs/base64');
encode('hello 中文'); // 'aGVsbG8g5Lit5aSp'

अपनी स्क्रिप्ट लाइब्रेरी​

पुनः उपयोग योग्य फ़ंक्शन स्क्रिप्ट लाइब्रेरी के रूप में सेव करें (module.exports से एक्सपोर्ट, एंट्री फ़ंक्शन ज़रूरी नहीं) और किसी भी प्री/पोस्ट स्क्रिप्ट से require करें:

// script library "sign-lib"
function sign(method, path, body, secret) {
return $hmac.sha256(method + path + body, secret);
}
module.exports = { sign };
// any request script
async function onRequest(context, url, request) {
const { sign } = require('@libs/sign-lib');
request.headers.set('X-Sign', sign('POST', request.path, request.body.parseText(), sdk.env.get('secret')));
return request;
}
  • स्थिर आइडेंटिफ़ायर रूप पाने के लिए लाइब्रेरी मैनेजर में Copy require statement उपयोग करें।
  • लाइब्रेरी दूसरी लाइब्रेरी require कर सकती हैं — पूरा डिपेंडेंसी क्लोज़र अपने-आप बंडल होता है (साइकल Node-स्टाइल रिज़ॉल्व, कोई इनफ़िनिट लूप नहीं)।
  • मॉड्यूल कैश हर एक्ज़ीक्यूशन पर फिर से बनता है: लाइब्रेरी कभी रिक्वेस्ट के बीच स्टेट नहीं रखतीं।
  • npm पैकेज पुनः उपयोग करने के लिए, पहले उसे एक फ़ाइल में बंडल करें (जैसे esbuild --format=iife, या Browserify/Webpack), फ़ाइल को स्क्रिप्ट लाइब्रेरी के रूप में इंपोर्ट करें, फिर require('@libs/<name>')। Node (Buffer/fs/crypto/process) या DOM डिपेंडेंसी रहित शुद्ध-JS बिल्ड चुनें।
  • ग़लत की Error: require: 未找到库 [...] थ्रो करती है — प्री-सेंड विफलता रिक्वेस्ट एबॉर्ट करती है, पोस्ट-रिस्पॉन्स विफलता मूल रिस्पॉन्स रखती है। कमेंट के अंदर require कॉल अनदेखे।

पूरी require सिमैंटिक्स: Script API Reference।


कई स्क्रिप्ट कैसे सहयोग करते हैं​

जब एक रिक्वेस्ट में कई स्क्रिप्ट हों, वे वही globalThis शेयर करते हैं (सत्यापित)। तो आप:

लाभ: हर स्क्रिप्ट की एक ज़िम्मेदारी है और वे स्वतंत्र रूप से टॉगल हो सकते हैं। "लाइब्रेरी स्क्रिप्ट" भी पूरा स्क्रिप्ट है (अपने onRequest/onResponse के साथ) — पूरी चेन चलाने के लिए चरण के रूप में जोड़ें, या उसमें module.exports से शुद्ध फ़ंक्शन रखें और require('@libs/<key>') से लोड करें (देखें require() से स्क्रिप्ट लाइब्रेरी लोड करना)।

ठोस चेन उदाहरण (टोकन के लिए लॉगिन, AES राउंड-ट्रिप) recipes में देखें।