Anforderung Abrufen – Umfang, Global
Die Anforderung Abrufen Die API enthält Methoden zum Erstellen oder Abrufen eines Anforderungsobjekts, damit Anwendungen Ressourcen wie JSON, Text oder Binärdaten asynchron von einem Server anfordern können. und bearbeiten Sie die Antwort. Diese API unterstützt verschiedene HTTP-Methoden wie GET, POST, PUT, DELETE usw.
- Abrufen – Abrufen (Zeichenfolgenressource, Objektoptionen): Starten Sie den Prozess des Abrufs einer Ressource aus dem Netzwerk.
- Header Abrufen – Umfang, Global: Anforderungs- und Antwortheader abrufen und ändern.
- Anforderung Abrufen – Umfang, Global: Erstellen Sie ein neues Anforderungsobjekt.
- Rufen Sie „RequestInit“ ab – Umfang, Global: Legen Sie Optionen zum Konfigurieren einer Abrufanforderung fest.
- Antwort Abrufen – Umfang, Global: Erstellen Sie ein neues Antwortobjekt.
Zur Unterstützung von Abrufaktionen die Systemeigenschaft Glide.Hosts.Zulässigkeitsliste , Ermöglicht Steuerungen darüber, auf welche Hosts eine Abrufmethode zugreifen kann. Gilt für HTTP-APIs wie RestMessageV2 Und die oben genannten. Weitere Informationen zu finden Glide.Hosts.Zulässigkeitsliste , Siehe Available system properties.
Anforderungseigenschaften
Die Anforderung Abrufen Die API unterstützt mehrere schreibgeschützte Eigenschaften, die detaillierte Informationen zu einer HTTP-Anforderung bieten. Einige davon sind url (Die URL der Anforderung), Methode (Die HTTP-Methode), Header (Die zugeordneten Header), und Textkörper (Der Anforderungstext als Stream). Andere Eigenschaften umfassen Einstellungen für Caching, Anmeldeinformationen und Referrer. Diese Eigenschaften sind schreibgeschützt, d. h. sie können nach dem Erstellen der Anforderung aufgerufen, aber nicht geändert werden. Weitere Informationen zu den einzelnen Eigenschaften finden Sie unter https://developer.mozilla.org/en-US/docs/Web/API/Request.
| Eigenschaftsname | Beschreibung | Beispiel |
|---|---|---|
| body | Eigenschaft „nur bereit“. Enthält einen lesbaren Stream von Byte-Daten mit den Textkörperinhalten, die der Anforderung hinzugefügt wurden. Datentyp/Wert: Ein ReadableStream oder null. |
|
| Körperverwendet | Eigenschaft „nur bereit“. Kennzeichnung, die angibt, ob der Anforderungstext noch gelesen wurde. Akzeptierter Wert:
Datentyp: Boolesch |
|
| Cache | Eigenschaft „nur bereit“. Enthält den Cache-Modus der Anforderung, der steuert, wie die Anforderung mit dem HTTP-Cache des Browsers interagiert. Akzeptierte Werte:
Datentyp: Zeichenfolge |
|
| Anmeldeinformationen | Schreibgeschützt. Spiegelt den Wert wider, der für angegeben wurde Anforderung () Konstruktor in der Anmeldeinformationsoption. Anmeldeinformationen sind Cookies, TLS-Clientzertifikate oder Authentifizierungsheader, die einen Anwendernamen und ein Passwort enthalten. Akzeptierte Werte:
Datentyp: Zeichenfolge |
|
| destination | Schreibgeschützt. Gibt eine Zeichenfolge zurück, die den Typ des angeforderten Inhalts beschreibt. Akzeptierte Werte:
Datentyp: Zeichenfolge |
|
| headers | Schreibgeschützt. Das Headerobjekt, das der Anforderung zugeordnet ist. Datentyp: Header-Objekt |
|
| Integrität | Schreibgeschützt. Der Integritätswert der Unterressource der Anforderung. Wert: Der Wert, der als übergeben wurde options.integrityArgument beim Erstellen der Anforderung. Wenn keine Integrität angegeben wurde, wird die Eigenschaft zurückgegeben |
|
| IsHistoryNavigation | Schreibgeschützt. Boolescher Wert, der angibt, ob die Anforderung eine Verlaufsnavigation ist. Akzeptierte Werte:
Datentyp: Boolesch |
|
| Keepalive | Schreibgeschützt. Keepalive-Einstellung der Anforderung (wahr oder falsch). Gibt eine leere Zeichenfolge zurück, wenn in der Anforderung kein Integritätswert übergeben wird. Akzeptierte Werte:
Datentyp: Boolesch |
|
| method | Schreibgeschützt. Die Methode der Anforderung ( ABRUFEN , VERÖFFENTLICHEN , Usw.)Datentyp: Zeichenfolge |
|
| Modus | Schreibgeschützt. Modus der Anforderung. Wird verwendet, um zu bestimmen, ob Cross-Origin-Anforderungen zu gültigen Antworten führen und welche Eigenschaften der Antwort lesbar sind. Akzeptierte Werte:
Anforderungen können auf verschiedene Arten initiiert werden, und der Modus für eine Anforderung hängt von der jeweiligen Methode ab, mit der sie initiiert wurde. Beispiel: Wenn ein Anforderungsobjekt mit erstellt wird Anforderung () Konstruktor, der Wert der Moduseigenschaft für diese Anforderung wird auf cors festgelegt. Jedoch für Anforderungen, die nicht von erstellt wurden Anforderung () Konstruktor wird normalerweise „no-cors“ als Modus verwendet. Beispiel: Für eingebettete Ressourcen, bei denen die Anforderung über Markup initiiert wird, wird die Anforderung, sofern das Crossorigin-Attribut nicht vorhanden ist, in den meisten Fällen im No-cors-Modus gestellt, d. h. für <link>Oder <script> elements (except when used with modules), or <img>, <audio>,<video>, <object>, <embed>, or <iframe> elements. Datentyp: Zeichenfolge |
|
| umleiten | Schreibgeschützt. Modus für die Behandlung von Umleitungen. Gültige Werte:
Datentyp: Zeichenfolge Standard: Folgen |
|
| Referrer | Schreibgeschützt. Der Referrer der Anforderung (z. B. Client , Kein Referrer , Oder eine URL). Ein Wert von Kein Referrer Gibt eine leere Zeichenfolge zurück.Datentyp: Zeichenfolge |
|
| ReferrerPolicy | Schreibgeschützt. Die Referrer-Richtlinie, die steuert, welche Referrer-Informationen im Referrer-Header mit der Anforderung gesendet werden. Datentyp: Zeichenfolge |
|
| signal | Schreibgeschützt. AbortSignal, das der Anforderung zugeordnet ist. Datentyp: Zeichenfolge |
|
| URL | Schreibgeschützt. URL der Anforderung. Datentyp: Zeichenfolge |
|
Anforderung Abrufen – Request()
Erstellt ein neues Anforderungsobjekt. Erstellen Sie optional das Anforderungsobjekt aus einer URL oder Objektressource.
| Name | Typ | Beschreibung |
|---|---|---|
| Eingabe | Zeichenfolge oder Objekt | Optional. Die abzurufende Ressource. Gültige Werte:
|
| Optionen | Objekt | Optional. A Rufen Sie „RequestInit“ ab – Umfang, Global Objekt mit anwenderdefinierten Einstellungen, die auf die Anforderung angewendet werden sollen. Wenn Sie eine neue Anforderung aus einer vorhandenen Anforderung erstellen, überschreiben die in der neuen Anforderung festgelegten Optionen alle entsprechenden Optionen in der ursprünglichen Anforderung. Standard: Gibt Standardwerte für alle Eigenschaften zurück. |
Das folgende Beispiel zeigt, wie ein neues Anforderungsobjekt mit erstellt wird Anforderung () Konstruktor.
var myImage = document.querySelector("img");
var myRequest = new Request("flowers.jpg");
Das folgende Beispiel zeigt, wie das neue Anforderungsobjekt mithilfe des Eingabeparameters erstellt wird, um eine URL oder ein Objekt abzurufen.
var myImage = document.querySelector("img");
var myRequest = new Request("flowers.jpg");
fetch(myRequest)
.then((response) => response.blob())
.then((response) => {
var objectURL = URL.createObjectURL(response);
myImage.src = objectURL;
});
Das folgende Beispiel zeigt, wie Sie das neue Anforderungsobjekt mit Headeroptionen mithilfe eines Objektliterals erstellen.
var myImage = document.querySelector("img");
var myRequest = new Request("flowers.jpg");
var options = {
headers: {
"Cache-Control": "max-age=60480",
},
};
Anforderung abrufen – arrayBuffer()
Liest den Anforderungstext und gibt ihn als Zusage zurück, die mit einem arrayBuffer gelöst wird.
| Name | Typ | Beschreibung |
|---|---|---|
| Keine |
| Typ | Beschreibung |
|---|---|
| Zusage | Eine Zusage, die mit gelöst wird ArrayBuffer . |
Im Folgenden wird gezeigt, wie mit eine neue Anforderung erstellt wird ArrayBuffer() Methode.
var myArray = new Uint8Array(10);
var request = new Request("/myEndpoint", {
method: "POST",
body: myArray,
});
request.arrayBuffer().then((buffer) => {
// perform an action with the buffer sent in the request
});
Anforderung abrufen – blob()
Liest den Anforderungstext und gibt ihn als Zusage zurück, die mit einem Blob gelöst wird.
| Name | Typ | Beschreibung |
|---|---|---|
| Keine |
| Typ | Beschreibung |
|---|---|
| Objekt | Ein Versprechen, das mit gelöst wird Blob . |
Das folgende Beispiel zeigt, wie Sie eine Anforderung mit erstellen blob() Methode.
var obj = { hello: "world" };
var myBlob = new Blob([JSON.stringify(obj, null, 2)], {
type: "application/json",
});
var request = new Request("/myEndpoint", {
method: "POST",
body: myBlob,
});
request.blob().then((myBlob) => {
// do something with the blob sent in the request
});
Anforderung abrufen – bytes()
Liest den Anforderungstext und gibt ihn als Zusage zurück, die mit einem Uint8Array gelöst wird.
| Name | Typ | Beschreibung |
|---|---|---|
| Keine |
| Typ | Beschreibung |
|---|---|
| Objekt | Eine Zusage, die mit gelöst wird Uint8Array . |
Im Folgenden wird gezeigt, wie mit eine neue Anforderung erstellt wird Byte() Methode.
var myArray = new Uint8Array(10);
var request = new Request("/myEndpoint", {
method: "POST",
body: myArray,
});
request.bytes().then((buffer) => {
// do something with the buffer sent in the request
});
Anforderung abrufen – Klon()
Erstellt eine Kopie des aktuellen Anforderungsobjekts.
| Name | Typ | Beschreibung |
|---|---|---|
| Keine |
| Typ | Beschreibung |
|---|---|
| Anforderung | Ein Anforderungsobjekt, das eine genaue Kopie der Anforderung ist, die Klon () Wurde aufgerufen am. Klon () Löst einen Fehler aus, wenn der Anforderungstext bereits verwendet wurde. Wenn Sie die Anforderung ändern möchten, verwenden Sie Anforderung Abrufen – Request() Konstruktor. |
Das folgende Beispiel zeigt, wie Sie mit eine neue Anforderung erstellen Anforderung () Und kopieren Sie es dann mit Klon () .
var myRequest = new Request("flowers.jpg");
var newRequest = myRequest.clone(); // a copy of the request is now stored in newRequest
Anforderung abrufen – formData()
Liest den Anforderungstext und gibt ihn als Zusage zurück, die mit einem FormData-Objekt gelöst wird.
| Name | Typ | Beschreibung |
|---|---|---|
| Keine |
| Typ | Beschreibung |
|---|---|
| Keine | Ein Versprechen, das mit gelöst wird Formulardaten Objekt. |
Das folgende Beispiel zeigt, wie Sie mit eine neue Anforderung erstellen Anforderung () Und lösen Sie es dann mit der Methode „formData()“ auf, um es als FormData-Objekt aufzulösen.
var formData = new FormData();
var fileField = document.querySelector('input[type="file"]');
formData.append("username", "abc123");
formData.append("avatar", fileField.files[0]);
var request = new Request("/myEndpoint", {
method: "POST",
body: formData,
});
request.formData().then((data) => {
// do something with the formdata sent in the request
});
Anforderung abrufen – JSON()
Liest den Anforderungstext, analysiert den Inhalt als JSON und gibt eine Zusage zurück, die mit dem analysierten Ergebnis aufgelöst wird.
| Name | Typ | Beschreibung |
|---|---|---|
| Keine |
| Typ | Beschreibung |
|---|---|
| Objekt | Eine Zusage (der spätere Abschluss oder ein Fehler eines asynchronen Vorgangs und sein resultierender Wert), die sich in ein JavaScript-Objekt löst. Dieses Objekt kann alles sein, was von JSON dargestellt werden kann: Ein Objekt, ein Array, eine Zeichenfolge, eine Zahl usw. |
Das folgende Beispiel zeigt, wie Sie mit eine neue Anforderung erstellen Anforderung () Und dann json() Um die Anforderung zu analysieren und als JSON-Objekt zurückzugeben.
var obj = { hello: "world" };
var request = new Request("/myEndpoint", {
method: "POST",
body: JSON.stringify(obj),
});
request.json().then((data) => {
// process the data sent in the request
});
Anforderung abrufen – Text()
Liest den Anforderungstext und gibt ihn als Zusage zurück, die mit einer Zeichenfolge gelöst wird, die mit UTF-8 decodiert wurde.
| Name | Typ | Beschreibung |
|---|---|---|
| Keine |
| Typ | Beschreibung |
|---|---|
| Keine | Eine Zusage, die mit einer Zeichenfolge im UTF-8-Format aufgelöst wird. |
Dieses Beispiel zeigt, wie Sie anrufen Text() .
var text = "Hello world";
var request = new Request("/myEndpoint", {
method: "POST",
body: text,
});
request.text().then((text) => {
// process the data sent in the request
});