Wenn du mit dem Konzept der Variablen noch nicht vertraut bist, empfehlen wir den Artikel zu Variablen, um einen Überblick zur Funktionsweise zu erhalten. Dieser Artikel bietet einen Überblick über vordefinierte Variablen und wie du sie nutzen und in einem Multi-Step API-Prüfobjekt einrichten kannst
Vordefinierte Variablen
Vordefinierte Variablen ermöglichen dir, Werte aus HTTP-Antworten entweder zu erfassen und zu speichern oder eigene Werte zu Beginn eines API-Szenarios anzugeben. Unter dem Schritte-Editor siehst du einen Bereich, in dem du vordefinierte Variablen angeben kannst.
Wie im Bild zu sehen ist, enthält die Variable {{BaseUrl}}
den Wert https://galacticresorts.com. Statt wiederholt URLs für jeden Schritt anzugeben, kannst du einfach die Variable nutzen, um unterschiedliche Endpunkte für jeden Schritt, zum Beispiel {{BaseUrl}}/Products und {{BaseUrl}}/Status, anzusteuern. Du kannst auch von einer Umgebung zu einer anderen wechseln, indem du einfach den Wert der Variable zu https://test-galacticresorts.com änderst.
Ein weitere üblicher Einsatzbereich für vordefinierte Variablen ist das Speichern deines API Keys zur Authentifizierung. Wenn du deine Anmeldedaten als Variable definierst, kannst du sensible Daten sicher handhaben und den Wert bei Bedarf an einem einzigen Ort aktualisieren. Du kannst auch Vault Anmeldedaten als vordefinierte Variablen abrufen und nutzen.
Vordefinierte Variablen einrichten
Um eine vordefinierte Variable hinzuzufügen:
- Gehe zu Vordefinierte Variablen unter dem visuellen Schritte-Editor.
- Klicke auf .
- Gib den Variablennamen im Feld Name ein. Zum Beispiel
BaseUrl. - Klicke auf und wähle einen Wert. Dabei kann es sich um Klartext oder Vault Anmeldedaten handeln.
- Gib den Wert der Variable an. Zum Beispiel
https://test.yourapi.com.
Nach der Erstellung kannst du die Variable in deinen API-Schritten mit folgender Syntax einsetzen: {{VariableName}}. Wenn du sie als Basis-URL für jeden API-Schritt referenzieren möchtest, verwende: {{BaseURL}}/UserService/GetUserInfo oder {{BaseURL}}/UserService/GetProductInfo. Auf diese Weise kannst du den Wert der Variable ganz einfach aktualisieren und auf unterschiedliche Umgebungen wie die Staging- oder Produktionsumgebung verweisen, ohne jeden Schritt bearbeiten zu müssen.
Vault Anmeldedaten als vordefinierte Variablen nutzen
Vordefinierte Variablen können auch sensible Informationen speichern und sie an beliebiger Stelle im API-Szenario verwenden. Benötigt deine API eine Authentifizierung wie eine Anmeldung oder den Abruf eines Zugriff-Tokens, kannst du eine Variable verwenden, um deine Anmeldedaten zu speichern und in deinen Abfragen zu nutzen.
Uptrends bietet eine Vault, in der du sensible Daten innerhalb deines Uptrends Account sicher speichern kannst.
Um Vault Anmeldedaten als vordefinierte Variable zu nutzen:
- Stelle sicher, dass die Anmeldedaten in deiner Uptrends Vault hinzugefügt wurden.
- Richte eine vordefinierte Variable ein.
- Klicke auf .
- Wähle Vault Anmeldedaten.
- Wähle ein Credential Set zusammen mit seinem Wert. Zum Beispiel ein Benutzername-Passwort-Credential-Set.
- Klicke auf Auswählen.
Nach der Erstellung kannst du die Variable in deinen API-Schritten nutzen. In dem Beispiel wurde das Credential Set in den Response Headern verwendet. In den Kontrolldetails der Prüfobjektergebnisse sind die Werte maskiert, um die sensiblen Daten zu verbergen.
