Environnement de test de l'API Explorer

Qu'est-ce que l'environnement dans l'outil de test Apigit ?

L'environnement d'Apigit est une fonctionnalité qui vous permet de créer et de gérer différents ensembles de variables pouvant être utilisées dans vos requêtes. Un environnement peut être considéré comme un ensemble de paires clé-valeur accessibles et modifiables dans Apigit.

En termes plus simples, un environnement est un moyen de stocker des variables telles que des URL, des jetons d'accès et d'autres valeurs fréquemment utilisées dans vos requêtes API. En stockant ces valeurs dans un environnement, vous pouvez facilement basculer entre différentes configurations et exécuter vos demandes dans différents environnements sans mettre à jour manuellement les valeurs à chaque fois.

Chaque environnement d'Apigit se compose d'un ensemble de variables, y compris des variables globales accessibles par toutes les requêtes dans l'espace de travail, et des variables spécifiques à l'environnement qui ne sont disponibles que pour les requêtes de cet environnement. Les variables peuvent être définies et mises à jour manuellement, ou elles peuvent être définies dynamiquement à l'aide de scripts ou de l'API Apigit.

Vous pouvez créer plusieurs environnements dans un espace de travail Apigit et basculer facilement entre eux à l'aide du menu déroulant des environnements. Cela facilite le test de votre API dans différents environnements, tels que le développement, la mise en scène et la production, sans avoir à mettre à jour manuellement vos demandes à chaque fois.

Créez votre premier ensemble d'environnements

Lors du débogage d'une API, nous devons souvent basculer entre les environnements locaux, de développement et de production. Nous sommes également confrontés à des problèmes tels que les jetons expirés, ce qui peut être frustrant. Certains tutoriels suggèrent d'utiliser Apigit pour simplifier le processus, mais en pratique, nous pouvons encore rencontrer quelques problèmes. Par conséquent, cet article de blog détaillé présente l'utilisation des environnements d'Apigit pour simplifier les étapes de basculement entre différents environnements lors du débogage des API de manière transparente.

Étapes pour utiliser un environnement de données global :

Pour modifier votre fichier de scénario de test, accédez àTest Cases dans votre référentiel et sélectionnez le fichier approprié. Dans le mode d'affichage par défaut, cliquez sur l'icône ✏️ située dans le coin inférieur gauche de la barre latérale.

Pour ajouter ou modifier un ensemble d'environnements, cliquez sur leEnv situé au centre de la barre supérieure. De là, vous pouvez accéder aux paramètres d'environnement et apporter les modifications nécessaires.

Vous avez la possibilité de basculer entreCode etForm modes d'affichage en cliquant sur les boutons correspondants situés en haut à droite de la page.

DansCode mode:

[
  {
    "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}"
    }
  }
]

DansForm mode:

Pour utiliser les données d'environnement, vous pouvez ajouter du code dansCode Execution Action ouTest section deHttp Request Action.

Notez que l'utilisation devar est limité à sa propre section. Si vous définissez une variable, telle quetest, dans la sectionCode Execution Action et souhaitez l'utiliser dans leHTTP Request Action section, vous devez utiliserstate.test pour accéder à la variable.