Wie das Transaktionsprüfobjekt verfügt auch der Prüfobjekttyp Multi-step API über eine Editorversion für die Skript-Ansicht als eine Alternative zum visuellen Standardeditor. Der Skript-Editor ermöglicht genauso wie der visuelle Editor Änderungen an den Schritten des Prüfobjekts, aber im JSON-Skript statt über die Benutzeroberfläche.
Vorteile des Skript-Editors
Es gibt mehrere Vorteile beim Einsatz eines Skript-Editors gegenüber den Prüfobjektsänderungen über die Benutzeroberfläche:
- Power-User empfinden das direkte Bearbeiten eines Skripts einfacher als das Navigieren durch eine Benutzeroberfläche. Einige Nutzer ziehen eine Arbeitsweise ähnlich dem Einsatz einer Befehlszeile vor.
- Wenn ein Skript verfügbar ist, ist eine Automatisierung möglich, beispielsweise um deine CI/CD-Prozesse einzubauen. Mit der Uptrends API kannst du die Schritte des Prüfobjekts im selben Moment aktualisieren, wie du die API aktualisierst, die damit geprüft wird.
- Über den Skript-Editor kannst du eine lokale Kopie der Schritte deines Prüfobjekts erstellen, indem du das Skript einfach kopierst und es in eine lokale Datei einfügst. Eine lokale Kopie bietet eine Versionskontrolle, Sicherungen des Multi-step API-Prüfobjekts und ein einfaches Reproduzieren komplizierter Einrichtungen:
Wechsel zum Skript-Editor
Rufe den Skript-Editor für ein beliebiges Multi-step API-Prüfobjekt auf, indem du zu den Prüfobjekten wechselst, die Registerkarte Schritte aufrufst und auf die Schaltfläche WECHSLE ZUM SKRIPT oben rechts klickst. Der Wechsel in und aus dem Skript-Editor löst eine Validierung aus, mit der sichergestellt wird, dass das JSON im Skript korrekt bleibt. Das Skript sieht folgendermaßen aus:
Das Skript verstehen
Wie zu sehen, ist das Skript im Grunde eine JSON-formatierte Reihe einzelner Schritte, die die konfigurierte Request-Methode, URL, Header und Request Body sowie die Authentifizierungsoptionen enthalten. Darüber hinaus enthält jeder Schritt-Eintrag die Definitionen für jegliche Variablen, die aus der Antwort erzeugt wurden, sowie Assertions die zu ihr erstellt wurden. Alle notwendigen Änderungen können direkt im Skript-Editor vorgenommen werden.
Ein einzelner Schritt wird in etwa folgendermaßen aussehen:
{
"StepType": "HttpRequest",
"Url": "http://galacticresorts.com/api/Destinations",
"Method": "GET",
"BodyType": "Raw",
"RequestHeaders": [
{
"Key": "accept",
"Value": "application/json"
}
],
"Variables": [
{
"Source": "ResponseBodyJson",
"Property": "[0].ProductId",
"Name": "ProductId",
"Arguments": []
}
],
"Assertions": [
{
"Source": "ResponseBodyJson",
"Property": "[0].ProductId",
"Comparison": "DoesNotEqual",
"TargetValue": "100"
}
],
"Name": "Get destinations",
"UseFixedClientCertificate": false,
"Authentication": {
"Id": "5ef65980-8577-4d8c-b359-91551feef03d",
"AuthenticationType": "None",
"PasswordSpecified": false
},
"IgnoreCertificateErrors": false,
"Encoding": "Utf8",
"RetryUntilSuccessful": false,
"MaxAttempts": 0,
"discriminator": "HttpRequestStepV2"
}
Das Hinzufügen weiterer Schritte ist genauso einfach wie das Einfügen weiterer Einträge in das Array – mit der vollständigen oben dargestellten Schrittdefinition.
Nach dem Array mit den Schritten, enthält die Schrittdefinition auch Informationen zu vordefinierten Variablen oder benutzerdefinierten Funktionen, die du eingerichtet hast:
"PredefinedVariables": [
{
"Key": "examplePredefinedVariable",
"Value": "example value"
}
],
"UserDefinedFunctions": [
{
"Mapping": {
"Error": "Red",
"Ok": "Green"
},
"Name": "exampleMapping",
"discriminator": "UserDefinedFunctionMapping"
}
]