Mit der API zum Abrufen von Headern können Sie Header aus einer Liste von Anforderungs- oder Antwort-Headern abrufen, festlegen, hinzufügen und entfernen.
Diese API ist Teil einer Reihe von Abruf -APIs, die verschiedene Aktionen zum Abrufen von Ressourcen von externen Websites bereitstellen. Die vollständige API-Sammlung zum Abrufen enthält:
Zur Unterstützung von Abrufaktionen ermöglicht die Systemeigenschaft glide.hosts.allowlistdie Steuerung, auf welche Hosts eine Abrufmethode zugreifen kann. Sie gilt für HTTP-APIs wie RestMessageV2 und die oben genannten. Weitere Informationen zu glide.hosts.allowlistfinden Sie unter Available system properties.
Header abrufen – Headers(init)
Der Headers() -Konstruktor erstellt ein neues, leeres Headers-Objekt. Sie können auch ein neues Header-Objekt erstellen und mit einer Liste von HTTP-Headern vorab ausfüllen, indem Sie den Parameter init verwenden.
Optional. Ein Objektliteral, das HTTP-Header enthält, mit denen das neue Header-Objekt vorab ausgefüllt wird.
Gültige Werte:
Ein Objektliteral mit Zeichenfolgenwerten,
Ein Array von Name/Wert-Paaren,
Ein vorhandenes Header-Objekt (bei dem das neue Objekt Daten aus dem vorhandenen Objekt kopiert)
Standard: Erstellt ein leeres Header-Objekt
Das folgende Beispiel zeigt, wie der Headers()- Konstruktor verwendet wird, um ein neues Headers-Objekt mit und ohne Header zu erstellen.
//Intializes an empty Headers object.
var headers = new Headers();
//Sets the new Headers object with a list of headers.
var httpHeaders = {
"Content-Type": "application/json",
"X-My-Custom-Header": "XYZ",
};
var myHeaders = new Headers(httpHeaders);
Fügt einem vorhandenen Header in einem Headers-Objekt einen neuen Wert hinzu oder fügt den Header hinzu, wenn er noch nicht vorhanden ist.
Wenn der angegebene Header bereits vorhanden ist, ändert append() den vorhandenen Wert in den angegebenen Wert. Wenn der angegebene Header bereits vorhanden ist und mehrere Werte akzeptiert, hängt der neue Wert von append() an das Ende des Wertsatzes an. Um den alten Wert mit einem neuen zu überschreiben, verwenden Sie Header abrufen – festlegen (Zeichenfolgenname, Zeichenfolgenwert).
Tabelle : 2. Parameter
Name
Typ
Beschreibung
Name
Zeichenfolge
Erforderlich. Der Name des HTTP-Headers, der dem Header-Objekt hinzugefügt werden soll.
Wert
Zeichenfolge
Erforderlich. Der Wert des hinzuzufügenden HTTP-Headers.
Tabelle : 3. Rückgaben
Typ
Beschreibung
Keine
Das folgende Beispiel zeigt, wie Sie mit append()einen Header hinzufügen:
var myHeaders = new Headers(); // Currently empty
myHeaders.append("Content-Type", "image/jpeg");
myHeaders.get("Content-Type"); // Returns 'image/jpeg'
Ausgabe:
“image/jpeg”
Das folgende Beispiel zeigt, wie ein neuer Header angehängt wird, der mehrere Werte akzeptiert:
var myHeaders = new Headers(); // Currently empty
myHeaders.append("Accept-Encoding", "deflate");
myHeaders.append("Accept-Encoding", "gzip");
myHeaders.get("Accept-Encoding"); // Returns 'deflate, gzip'
Ausgabe:
{“deflate”, “gzip”}
Header abrufen – löschen (Zeichenfolgenname)
Löscht einen Header aus dem aktuellen Header-Objekt.
Tabelle : 4. Parameter
Name
Typ
Beschreibung
Name
Zeichenfolge
Der Name des HTTP-Headers, der aus dem Header-Objekt gelöscht werden soll.
Tabelle : 5. Rückgaben
Typ
Beschreibung
Keine
Das folgende Beispiel zeigt, wie dem Headers-Objekt mit append()zuerst ein Header hinzugefügt und dann mit delete()gelöscht wird.
var myHeaders =newHeaders();// Currently empty
myHeaders.append("Content-Type","image/jpeg");
myHeaders.get("Content-Type");// Returns 'image/jpeg'
Das folgende Beispiel zeigt, dass der Endpunkt den Wert null zurückgibt, wenn das Headers-Objekt bereits gelöscht wurde:
myHeaders.delete("Content-Type");
myHeaders.get("Content-Type");// Returns null, as it has been deleted
Ausgabe:
null
Header abrufen – Einträge ()
Gibt einen Iterator zurück, mit dem Sie alle Schlüssel-Wert-Paare (dargestellt durch Zeichenfolgen) durchlaufen können, die im Header-Objekt enthalten sind.
Tabelle : 6. Parameter
Name
Typ
Beschreibung
Keine
Tabelle : 7. Ergebnisse
Typ
Beschreibung
Iterator
Gibt ein Iterator-Objekt zurück, bei dem sowohl das Schlüssel- als auch das Wertpaar Zeichenfolgenobjekte sind.
Das folgende Beispiel zeigt, wie Sie ein Test-Header-Objekt erstellen und anschließend die Methode „entries()“ verwenden, um einen Iterator aller Werte im Header-Objekt zurückzugeben.
// Create a test Headers object
var myHeaders = new Headers();
myHeaders.append("Content-Type", "text/xml");
myHeaders.append("Vary", "Accept-Language");
// Display the key/value pairs
for (var pair of myHeaders.entries()) {
console.log(`${pair[0]}: ${pair[1]}`);
}
Führt einmal für jedes Schlüssel-Wert-Paar im Header-Objekt eine Rückruffunktion aus.
Die Rückruffunktion wird für gelöschte Schlüssel nicht ausgeführt, wohl aber für vorhandene Schlüssel, selbst wenn der Wert nicht definiert ist.
Tabelle : 8. Parameter
Name
Typ
Beschreibung
callbackFn
Funktion
Funktion, die für jedes Schlüssel-Wert-Paar im Header-Objekt ausgeführt werden soll.
Entspricht dem folgenden Format: callbackFn(string key, Zeichenfolgenwert).
„callbackFn.value“
Zeichenfolge
Wert des Header-Eintrags.
callbackFn.key
Zeichenfolge
Name des Header-Eintrags.
„callBackFn.object“
Header
Das zu iterierende Header-Objekt.
thisArg
Objekt
Wert, der beim Ausführen des Rückrufs als dieserverwendet werden soll.
Tabelle : 9. Rückgaben
Typ
Beschreibung
Keine
Im folgenden Beispiel wird für jedes Schlüssel-Wert-Paar im Header-Objekt eine Zeile protokolliert:
// Create a new test Headers object
var myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");
myHeaders.append("Cookie", "This is a demo cookie");
myHeaders.append("compression", "gzip");
// Display the key/value pairs
myHeaders.forEach((value, key) => {
console.log(`${key} ==> ${value}`);
});
Ausgabe:
compression ==> gzip
content-type ==> application/json
cookie ==> This is a demo cookie
Header abrufen – get(String name)
Gibt eine Zeichenfolge aller Headerwerte eines angegebenen Headerobjekts zurück oder gibt null zurück, wenn der Header nicht vorhanden ist.
Tabelle : 10. Parameter
Name
Typ
Beschreibung
Name
Zeichenfolge
Der Name des HTTP-Headers, dessen Headerwerte Sie abrufen möchten (Groß-/Kleinschreibung beachten).
Tabelle : 11. Rückgaben
Typ
Beschreibung
Zeichenfolge
Der Wert des abgerufenen Headers (dargestellt als Zeichenfolge) oder null, wenn der Header nicht festgelegt ist.
Gibt einen Fehler zurück, wenn der Header nicht vorhanden ist. Gibt einen Typfehler zurück, wenn der angegebene Name nicht der eines HTTP-Headers ist.
Im Folgenden wird gezeigt, wie Sie mit append()ein Headerobjekt mit mehreren Headern erstellen und dann die Werte des Headers mit der get()- Methode zurückgeben.
var myHeaders = new Headers(); // Currently empty
myHeaders.append("Accept-Encoding", "deflate");
myHeaders.append("Accept-Encoding", "gzip");
myHeaders.get("Accept-Encoding"); // Returns "deflate, gzip"
myHeaders
.get("Accept-Encoding")
.split(",")
.map((v) => v.trimStart()); // Returns [ "deflate", "gzip"
Ausgabe:
[ "deflate", "gzip" ]
Header abrufen – getSetCookie()
Gibt alle Set-Cookie-Header zurück, die einer Antwort zugeordnet sind.
Tabelle : 12. Parameter
Name
Typ
Beschreibung
Keine
Tabelle : 13. Ergebnisse
Typ
Beschreibung
Array aus Zeichenfolgen
Ein Array von Zeichenfolgen, das die Werte aller Set-Cookie-Header enthält, die einer Antwort zugeordnet sind. Die Methode gibt ein leeres Array zurück, wenn keine Set-Cookie-Header festgelegt sind.
Das folgende Skriptbeispiel zeigt, wie getSetCookie() verwendet wird, um die der Antwort zugeordneten Headerwerte zurückzugeben:
var headers = new Headers({
"Set-Cookie": "name1=value1",
});
headers.append("Set-Cookie", "name2=value2");
headers.getSetCookie();
Ausgabe:
["name1=value1", "name2=value2"]
Header abrufen – hat (Zeichenfolgenname)
Gibt einen booleschen Wert zurück, der angibt, ob ein Header-Objekt den angegebenen Header enthält.
Tabelle : 14. Parameter
Name
Typ
Beschreibung
Name
Zeichenfolge
Der Name des HTTP-Headers, um zu überprüfen, ob er im Header-Objekt vorhanden ist oder nicht.
Tabelle : 15. Rückgaben
Typ
Beschreibung
Boolean
Kennzeichnung, die angibt, ob der angegebene Header im Header-Objekt vorhanden ist. Ein TypeError wird zurückgegeben, wenn der angegebene Header kein gültiger HTTP-Headername ist.
Mögliche Werte:
wahr: Der Header ist für das Objekt vorhanden.
„falsch“: Der Header ist für das Objekt nicht vorhanden.
Im folgenden Beispiel werden die Methoden Headers() und append() verwendet, um ein Header-Objekt mit dem Content-Type-Header zu erstellen und festzulegen. Im Beispiel wird dann die Methode has() verwendet, um zu zeigen, dass der Content-Type-Header im Headers-Objekt vorhanden ist, ein Allow-Coding-Header jedoch nicht.
var myHeaders = new Headers(); // Currently empty
myHeaders.append("Content-Type", "image/jpeg");
myHeaders.has("Content-Type"); // Returns true
myHeaders.has("Accept-Encoding"); // Returns false
Ausgabe:
true
false
Header abrufen – Schlüssel ()
Gibt einen Iterator zurück, mit dem Sie alle in einem Header-Objekt enthaltenen Schlüssel durchlaufen können.
Gibt einen Iterator zurück, wobei Header-Schlüssel als Zeichenfolgen dargestellt werden.
Das folgende Beispiel zeigt, wie Sie ein Headers-Objekt mit Schlüsseln erstellen und dann die Keys()- Methode verwenden, um eine Liste der verfügbaren Header zurückzugeben.
// Create a test Headers object
var myHeaders = new Headers();
myHeaders.append("Content-Type", "text/xml");
myHeaders.append("Vary", "Accept-Language");
// Display the keys
for (var key of myHeaders.keys()) {
console.log(key);
}
Aktualisiert den Wert eines vorhandenen Headers im Header-Objekt oder erstellt einen neuen Header mit dem angegebenen Wert, wenn der Header noch nicht vorhanden ist.
Der Name des HTTP-Headers, für den ein neuer Wert festgelegt werden soll. Löst TypeError aus, wenn der angegebene Name nicht der Name eines HTTP-Headers ist.
Wert
Zeichenfolge
Der neue Wert, der für den angegebenen Header festgelegt werden soll.
Tabelle : 19. Rückgaben
Typ
Beschreibung
Keine
Das folgende Beispiel zeigt, wie Sie mit append()einen Header in einem neuen Headers-Objekt festlegen und den Wert dann mit set()zurücksetzen.
var myHeaders = new Headers(); // Currently empty
myHeaders.append("Content-Type", "image/jpeg");
myHeaders.set("Content-Type", "text/html");
Ausgabe:
text/html
Das folgende Beispiel zeigt, wie ein Wert in einem Headers-Objekt festgelegt wird, wenn mehrere Werte akzeptiert werden:
Gibt einen Iterator zurück, wobei die Headerwerte als Zeichenfolgen dargestellt werden.
Das folgende Beispiel zeigt, wie Sie zuerst ein neues Header-Objekt mit mehreren Headern mithilfe der append()- Methode erstellen und festlegen und dann eine Liste aller Header-Werte im neuen Objekt zurückgeben, indem Sie die value()- Methode aufrufen. Console.log() protokolliert die Zeile in Systemprotokollen.
// Create a test Headers object
var myHeaders = new Headers();
myHeaders.append("Content-Type", "text/xml");
myHeaders.append("Vary", "Accept-Language");
// Display the values
for (var value of myHeaders.values()) {
console.log(value);
}