EchoAPI-Tutorial: So verwenden Sie Skripte in EchoAPI

In diesem Tutorial erfahren Sie, wie Sie Skripte in EchoAPI für erweiterte API-Tests und -Entwicklung verwenden. Mit in JavaScript geschriebenen EchoAPI-Skripten können Sie Ihren API-Anfragen dynamische Funktionen hinzufügen. Wenn Sie sowohl die Skripte vor als auch nach der Ausführung verstehen, können Sie Ihre Testfunktionen erweitern, Variablen verwalten und Anforderungsparameter mühelos bearbeiten. Lassen Sie uns in die leistungsstarken Funktionen von EchoAPI-Skripten eintauchen und sehen, wie sie Ihren API-Workflow optimieren können.

Was ist EchoAPI-Skript?

EchoAPI-Skripte sind auf JavaScript basierende Codeausschnitte, mit denen Sie dynamisches Verhalten bei API-Anfragen oder Sammlungstests hinzufügen können.

Funktionen von EchoAPI-Skripten

Skripte können die folgenden Funktionen erreichen:

• Testen (Assert) Sie die Richtigkeit der Anfrage-Antwort-Ergebnisse (Post-Execution-Skripte).
• API-Anforderungsparameter dynamisch ändern, z. B. API-Signaturparameter hinzufügen (Skripte vor der Ausführung).
• Daten zwischen API-Anfragen übergeben (Variablen in Skripten verwenden).
• Stellen Sie Anfragen direkt an einen API-Endpunkt innerhalb des Skripts.

EchoAPI-Skripte sind in Skripte vor der Ausführung und nach der Ausführung unterteilt.

Skripte vor der Ausführung

Skripte vor der Ausführung werden ausgeführt, bevor eine Anfrage gesendet wird.

Skripte nach der Ausführung

Post-Execution-Skripte werden ausgeführt, nachdem eine Anfrage gesendet wurde.

Beispiel für eine tatsächliche Einreichung

Wie im Diagramm unten (Konsolenausgabe) gezeigt, wird das Skript vor der Ausführung ausgeführt, bevor die Anforderung gesendet wird, und das Skript nach der Ausführung wird ausgeführt, nachdem die Anforderung abgeschlossen ist:

Funktionen von Pre-Execution-Skripten

Vorbereitende Skripte haben mehrere Schlüsselfunktionen:

• Führen Sie komplexe Berechnungen mit JS-Funktionen durch.
• Variablenwerte drucken.
• Umgebungsvariablen definieren, abrufen, löschen und löschen.
• Globale Variablen definieren, abrufen, löschen und löschen.
• Zugriffsanforderungsparameter.
• Header-Parameter dynamisch hinzufügen oder entfernen.
• Abfrageparameter dynamisch hinzufügen oder entfernen.
• Körperparameter dynamisch hinzufügen oder entfernen.
• HTTP-Anfragen senden.

Zum Beispiel können wir im Vorausführungsskript eine Funktion _random definieren:

function _random() {
    return 'Hello, EchoAPI ' + Math.random();
}

Diese Funktion gibt eine Zeichenfolge zurück: „Hallo, EchoAPI“, gefolgt von einer Zufallszahl. Wir können es dann wie folgt einer globalen Variablen random_var zuweisen:

pm.globals.set("random_var", _random());

Drucken von Debug-Variablen in Skripten vor der Ausführung

Wir können console.log() verwenden, um die erforderlichen Variablen auf der Konsole auszugeben und die aktuellen Werte dieser Variablen anzuzeigen.

Umgebungsvariablen verwalten

• Umgebungsvariable festlegen:

  pm.variables.set("key", "value"); // Set an environment variable 'key' with value 'value'

• Abrufen einer Umgebungsvariablen:

  pm.variables.get("key"); // Get the value of the environment variable 'key'

• Eine Umgebungsvariable löschen:

  pm.variables.delete("key"); // Delete the environment variable 'key'

• Alle Umgebungsvariablen löschen:

  pm.variables.clear(); // Clear all defined environment variables

Globale Variablen verwalten

• Eine globale Variable festlegen:

  pm.globals.set("key", "value"); // Set a global variable 'key' with value 'value'

• Eine globale Variable abrufen:

  pm.globals.get("key"); // Get the value of the global variable 'key'

• Eine globale Variable löschen:

  pm.globals.delete("key"); // Delete the global variable 'key'

• Alle globalen Variablen löschen:

  pm.globals.clear(); // Clear all defined global variables

Zugriff auf Anforderungsparameter

Auf Anforderungsparameter kann über das Anforderungsobjekt zugegriffen werden. Weitere Einzelheiten finden Sie im Abschnitt „Integrierte EchoAPI-Variablen“.

Anforderungsparameter dynamisch verwalten

• Hinzufügen eines Header-Parameters:

  pm.setRequestHeader("key", "value"); // Dynamically add a header parameter with key 'key' and value 'value'

• Entfernen eines Header-Parameters:

  pm.removeRequestHeader("key"); // Remove the header parameter with key 'key'

• Hinzufügen eines Abfrageparameters:

  pm.setRequestQuery("key", "value"); // Dynamically add a query parameter

• Entfernen eines Abfrageparameters:

  pm.removeRequestQuery("key"); // Remove the query parameter with key 'key'

• Hinzufügen eines Körperparameters:

  pm.setRequestBody("key", "value"); // Dynamically add a body parameter

• Entfernen eines Körperparameters:

  pm.removeRequestBody("key"); // Remove the body parameter with key 'key'

Senden von HTTP-Anfragen in Skripten vor der Ausführung

Sie können eine HTTP-Anfrage mit der $.ajax()-Methode von AJAX in einem Skript vor der Ausführung senden. Hier ist ein einfaches Beispiel, bei dem eine Anfrage an https://echo.apipost.cn/get.php gesendet wird und der Bigint der Antwort einer globalen Variablen Bigint zugewiesen wird:

function _random() {
    return 'Hello, EchoAPI ' + Math.random();
}

Funktionen von Post-Execution-Skripten

Post-Execution-Skripte werden ausgeführt, nachdem eine Anfrage gesendet wurde, und können viele der gleichen Funktionen wie Pre-Execution-Skripte ausführen, einschließlich:

• Führen Sie komplexe Berechnungen mit JS-Funktionen durch.
• Variablenwerte drucken.
• Umgebungsvariablen definieren, abrufen, löschen und löschen.
• Globale Variablen definieren, abrufen, löschen und löschen.
• Zugriff auf Anforderungs- und Antwortparameter.
• HTTP-Anfragen senden.
• Testen (bestätigen) Sie die Richtigkeit der Anfrage-Antwort-Ergebnisse.

Die Methoden zum Definieren, Abrufen, Löschen und Löschen von Umgebungs- und globalen Variablen sind die gleichen wie in Skripten vor der Ausführung und werden hier nicht wiederholt.

Antwortparameter empfangen

Über das Antwortobjekt können Sie auf Antwortparameter zugreifen. Ausführliche Informationen zu den Vorgängen finden Sie im Abschnitt „Integrierte EchoAPI-Variablen“.

Testen der Gültigkeit der Anforderungsantwort

Sie können Post-Execution-Skripte verwenden, um die Richtigkeit der Anfrage-Antwort-Ergebnisse zu testen (zu bestätigen).

Abschluss

Zusammenfassend lässt sich sagen, dass EchoAPI-Skripte eine robuste Möglichkeit bieten, Ihre API-Test- und Entwicklungsprozesse zu verbessern. Durch die Nutzung von Skripten vor und nach der Ausführung können Sie Anforderungsparameter dynamisch verwalten, die Antwortgültigkeit bestätigen und Variablen effektiv nutzen. Diese Funktionalität rationalisiert nicht nur den Testprozess, sondern ermöglicht auch komplexere Vorgänge, wodurch es einfacher wird, die Genauigkeit und Effizienz Ihrer API-Integrationen sicherzustellen. Beginnen Sie noch heute mit der Implementierung von EchoAPI-Skripten und verbessern Sie Ihr API-Testerlebnis!

Das obige ist der detaillierte Inhalt vonEchoAPI-Tutorial: So verwenden Sie Skripte in EchoAPI. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!