Entorno de prueba de API Explorer

¿Qué es el entorno en la herramienta de prueba Apigit?

El entorno de Apigit es una característica que le permite crear y administrar diferentes conjuntos de variables que se pueden usar en sus solicitudes. Se puede pensar en un entorno como una colección de pares clave-valor a los que se puede acceder y modificar dentro de Apigit.

En términos más simples, un entorno es una forma de almacenar variables como URL, tokens de acceso y otros valores que se usan con frecuencia en sus solicitudes de API. Al almacenar estos valores en un entorno, puede cambiar fácilmente entre diferentes configuraciones y ejecutar sus solicitudes en diferentes entornos sin actualizar manualmente los valores cada vez.

Cada entorno en Apigit consta de un conjunto de variables, incluidas las variables globales a las que pueden acceder todas las solicitudes en el espacio de trabajo y las variables específicas del entorno que solo están disponibles para las solicitudes dentro de ese entorno. Las variables se pueden configurar y actualizar manualmente, o se pueden configurar dinámicamente mediante scripts o la API de Apigit.

Puede crear varios entornos dentro de un espacio de trabajo de Apigit y cambiar fácilmente entre ellos mediante el menú desplegable de entornos. Esto facilita la prueba de su API en diferentes entornos, como desarrollo, preparación y producción, sin tener que actualizar manualmente sus solicitudes cada vez.

Crea tu primer conjunto de entornos

Al depurar una API, a menudo necesitamos alternar entre entornos locales, de desarrollo y de producción. También enfrentamos problemas como tokens caducados, que pueden ser frustrantes. Algunos tutoriales sugieren usar Apigit para simplificar el proceso, pero en la práctica, aún podemos encontrar algunos problemas. Por lo tanto, esta publicación de blog detallada presenta el uso de los entornos de Apigit para simplificar los pasos para cambiar entre diferentes entornos al depurar las API sin problemas.

Pasos para utilizar un entorno de datos global:

Para editar el archivo de su caso de prueba, vaya aTest Cases dentro de su repositorio y seleccione el archivo apropiado. En el modo de vista predeterminado, haz clic en el ícono ✏️ ubicado en la esquina inferior izquierda de la barra lateral.

Para agregar o editar un conjunto de entornos, haga clic en elEnv botón ubicado en el centro de la barra superior. Desde allí, puede acceder a la configuración del entorno y realizar los cambios necesarios.

Tienes la opción de cambiar entreCode yForm ver modos haciendo clic en los botones correspondientes ubicados en la esquina superior derecha de la página.

EnCode modo:

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

EnForm modo:

Para usar los datos del entorno, puede agregar código enCode Execution Action oTest Sección deHttp Request Action.

Tenga en cuenta que el uso devar se limita a su propia sección. Si define una variable, comotest, dentro de la secciónCode Execution Action y desea usarlo dentro delHTTP Request Action sección, debe utilizarstate.test para acceder a la variable.