Explorer-API-Testumgebung

Was ist die Umgebung im Apigit-Testtool?

Die Umgebung von Apigit ist eine Funktion, mit der Sie verschiedene Gruppen von Variablen erstellen und verwalten können, die in Ihren Anfragen verwendet werden können. Eine Umgebung kann als eine Sammlung von Schlüssel-Wert-Paaren betrachtet werden, auf die innerhalb von Apigit zugegriffen und die geändert werden kann.

Einfacher ausgedrückt ist eine Umgebung eine Möglichkeit, Variablen wie URLs, Zugriffstoken und andere Werte zu speichern, die häufig in Ihren API-Anforderungen verwendet werden. Indem Sie diese Werte in einer Umgebung speichern, können Sie problemlos zwischen verschiedenen Konfigurationen wechseln und Ihre Anforderungen für verschiedene Umgebungen ausführen, ohne die Werte jedes Mal manuell aktualisieren zu müssen.

Jede Umgebung in Apigit besteht aus einer Reihe von Variablen, einschließlich globaler Variablen, auf die alle Anforderungen im Arbeitsbereich zugreifen können, und umgebungsspezifischen Variablen, die nur für Anforderungen innerhalb dieser Umgebung verfügbar sind. Variablen können manuell festgelegt und aktualisiert werden, oder sie können mithilfe von Skripts oder der Apigit-API dynamisch festgelegt werden.

Sie können mehrere Umgebungen innerhalb eines Apigit-Arbeitsbereichs erstellen und mithilfe des Umgebungs-Dropdown-Menüs einfach zwischen ihnen wechseln. Dies macht es einfach, Ihre API in verschiedenen Umgebungen wie Entwicklung, Staging und Produktion zu testen, ohne Ihre Anforderungen jedes Mal manuell aktualisieren zu müssen.

Erstellen Sie Ihr erstes Umgebungsset

Beim Debuggen einer API müssen wir oft zwischen lokalen, Entwicklungs- und Produktionsumgebungen hin und her wechseln. Wir sind auch mit Problemen wie abgelaufenen Token konfrontiert, die frustrierend sein können. Einige Tutorials schlagen vor, Apigit zu verwenden, um den Prozess zu vereinfachen, aber in der Praxis können wir immer noch auf einige Probleme stoßen. Daher stellt dieser ausführliche Blogbeitrag die Verwendung von Apigits Umgebungen vor, um die Schritte zum Wechseln zwischen verschiedenen Umgebungen beim nahtlosen Debuggen von APIs zu vereinfachen.

Schritte zur Verwendung einer globalen Datenumgebung:

Um Ihre Testfalldatei zu bearbeiten, navigieren Sie zuTest Cases in Ihrem Repository und wählen Sie die entsprechende Datei aus. Klicken Sie im Standardansichtsmodus auf das Symbol ✏️ in der linken unteren Ecke der Seitenleiste.

Um ein Umgebungsset hinzuzufügen oder zu bearbeiten, klicken Sie auf dasEnv Schaltfläche in der Mitte der oberen Leiste. Von dort aus können Sie auf die Umgebungseinstellungen zugreifen und alle erforderlichen Änderungen vornehmen.

Sie haben die Möglichkeit, zwischen diesen zu wechselnCode UndForm Ansichtsmodi, indem Sie auf die entsprechenden Schaltflächen rechts oben auf der Seite klicken.

InCode Modus:

[
  {
    "type": "code",
    "description": "initialization",
    "parameters": {
      "code": "var baseUrl = env.get(\"baseUrl\");\nvar test = env.get(\"username\");\nif (test == null){\n    fail(\"test is null\");\n}\nif (baseUrl == null) {\n    state.baseUrl = \"http://petstore.mock.apigit.com\";\n    //env.set(\"baseUrl\", \"http://petstore.mock.apigit.com\")\n}\nstate.test = test;\n"
    }
  },
  {
    "type": "http",
    "description": "get pet inventories by username",
    "parameters": {
      "method": "get",
      "url": "{baseUrl}/store/inventory/{test}",
      "query": [],
      "auth": {
        "type": "{test}"
      },
      "header": [],
      "body": {
        "type": "none",
        "data": ""
      },
      "postTest": "if (!res || res.status !== 200) {\n    fail(\"get pet inventory failed\")\n}"
    }
  }
]

InForm Modus:

Um die Umgebungsdaten zu verwenden, können Sie Code hinzufügenCode Execution Action oderTest Abschnitt vonHttp Request Action.

Beachten Sie, dass die Verwendung vonvar ist auf einen eigenen Abschnitt beschränkt. Wenn Sie eine Variable definieren, wie ztest, im AbschnittCode Execution Action und möchten es innerhalb der verwendenHTTP Request Action Abschnitt, müssen Sie verwendenstate.test um auf die Variable zuzugreifen.