Uso de variables

En Apidog, las variables le permiten guardar y reutilizar valores fácilmente. Almacenar un valor como variable le permite acceder a él en diversos entornos, peticiones, scripts y escenarios de prueba. El uso de variables aumenta la productividad y fomenta el trabajo en equipo entre colegas.

¿Qué son las variables?

Una variable es una representación simbólica de datos que le permite recuperar un valor sin introducirlo manualmente cada vez que se necesita. Esto resulta útil para reutilizar los mismos valores en diferentes ubicaciones.

Ejemplo:
Si tiene el mismo token en varias peticiones y prevé cambios, guarde el token como una variable denominada {{my_token}}. Use {{my_token}} en el valor del parámetro de la petición. Cuando el token cambie, actualizar el valor de la variable lo actualizará en todas partes.

Las variables pueden aplicarse en valores de parámetros, cuerpos, URLs o encabezados.

En el módulo Pruebas de Apidog, las variables pueden utilizarse para pasar datos entre peticiones.

Alcances de las variables

Apidog admite variables en diversos alcances para adaptarse a diferentes requisitos de desarrollo, pruebas y colaboración.

Prioridad (de menor a mayor): Global < Módulo < Entorno < Datos < Local

Cuando se define una variable con el mismo nombre en diferentes alcances, prevalece el valor del alcance más estrecho.

Variables globales

Compartidas dentro del proyecto: Accesibles en todo un proyecto. Útiles para compartir datos entre endpoints (por ejemplo, token de inicio de sesión).

Compartidas dentro del equipo: Compartidas en todo el equipo a través de diferentes proyectos (por ejemplo, un token compartido entre un proyecto de inicio de sesión y un proyecto financiero).

NOTE

Permisos: Para gestionar variables de equipo, necesita permisos de administrador de equipo. Vaya a Recursos del equipo > Variables.

Scripts: Puede usar pm.globals.set para actualizar valores locales en scripts, pero no puede cambiar nombres ni valores compartidos.

Variables de módulo

Definidas dentro de un módulo. La importación desde las "Variables de colección" de Postman se asigna a variables de módulo.

Variables de entorno

Vinculadas a entornos específicos (Desarrollo, Pruebas, Producción). Solo son efectivas las variables del entorno activo.

Variables de datos

Procedentes de archivos CSV o JSON externos en Escenarios de prueba o CLI. Los valores no persisten después de la ejecución.

Variables locales

Variables temporales confinadas a una sola petición o ejecución de escenario de prueba. Desaparecen una vez completadas.

TIP

Las variables en Apidog se almacenan como cadenas. Al guardar objetos o matrices, use JSON.stringify() para almacenar y JSON.parse() para recuperarlos.

Valores compartidos y locales

Cada variable tiene dos estados:

Valor compartido: Sincronizado con los servidores de Apidog y compartido con el equipo.

Valor local: Almacenado LOCALMENTE en la caché de su navegador o cliente. No se comparte.

Mejores prácticas:

Use Valor local para datos confidenciales (tokens, contraseñas) de modo que permanezcan en su equipo.

Deje el valor local vacío para volver al valor compartido.

Haga clic en el icono de enlace 🔗 para sincronizar el valor local con el valor compartido.

WARNING

Limpiar la caché de Apidog eliminará los valores locales.

Los valores locales NO migran automáticamente al cambiar de dispositivo (use Exportar/Importar entorno).

Uso de variables en Apidog CLI

Al ejecutar en la CLI, se usa el Valor compartido de forma predeterminada, mientras que el cliente usa el Valor local. Esta es una causa común de discrepancias entre las ejecuciones del cliente y de la CLI.

TIP

Obtenga más información sobre Apidog CLI.

Definición de variables

1. Gestión de entornos (predefinida)

Los valores de las variables globales y de entorno pueden predefinirse manualmente.

Haga clic en el icono de Gestión de entornos ≡.

Seleccione Variables globales o un entorno específico.

Añada el nombre de la variable, el valor compartido y el valor local.

Haga clic en Guardar.

2. Extraer variables

Extraiga visualmente valores de respuestas de API a variables sin escribir código.

En la pestaña Ejecutar (Modo de diseño), vaya a Postprocesadores.

Seleccione Extraer variable.

Configure la fuente de extracción (JSON, XML, Encabezado, etc.) y JSONPath.

Envíe la petición para ejecutarla y verificarla en la Consola.

TIP

Obtenga más información sobre Extraer variable.

3. Scripts

Use el objeto pm en preprocesadores/postprocesadores.

Sintaxis para set:

Almacenamiento de objetos/matrices:

TIP

Obtenga más información sobre Sintaxis de scripts.

4. Operaciones de base de datos

Conéctese a una base de datos para recuperar datos y establecerlos como una variable.

Añada Operación de base de datos en Postprocesadores.

Configure la conexión de base de datos.

Introduzca el comando SQL (admite {{variable}}).

Establezca Extraer resultado a variable.

TIP

Obtenga más información sobre Operaciones de base de datos.

Parámetros de la petición

Use llaves dobles {{variable}} en URL, parámetros, encabezados o cuerpo.

URL de ejemplo:
http://127.0.0.1/pet/findByStatus?status={{CurrentStatus}}

Cuerpo JSON de ejemplo:

{
    "status": "{{CurrentStatus}}",
    "quantity": {{TotalPet}}
}

WARNING

Cadenas: Añada comillas dobles "" alrededor de la variable para cadenas (por ejemplo, "{{name}}").

Números/booleanos: NO añada comillas (por ejemplo, {{count}}).

Acceso a subelementos

Si una variable contiene un objeto/matriz JSON, acceda a las propiedades mediante notación de punto usando JSONPath.

Objeto en {{user}}:

{ "id": 1, "name": "Jack" }

Petición: {{user.name}}

Script: pm.variables.get("user.name")

Matriz en {{users}}:

[ { "name": "Jack" } ]

Petición: {{users[0].name}}

Script: pm.variables.get("users[0].name")

Uso de variables en scripts

En scripts, use pm.*.get() en lugar de {{}}.

Registro:

Revise la pestaña Consola para ver la salida.

Uso de variables de datos

En Escenarios de prueba, importar un archivo CSV/JSON crea "Variables de datos". Use {{column_name}} para hacer referencia a ellas. Cada fila del archivo desencadena una iteración independiente.

TIP

Obtenga más información sobre Pruebas basadas en datos.

Preguntas frecuentes

P: ¿Puedo usar variables en mocks?

No. Las variables se resuelven cuando se envía una petición. Los mocks son definiciones estáticas o se ejecutan en el servidor mock sin un contexto de "envío" del lado del cliente de la misma manera.

P: ¿Cómo obtengo la URL base en un script?

Use pm.request.getBaseUrl().

Evite pm.environment.get('BASE_URL'), ya que podría ser inexacto para endpoints de servidor no predeterminados.

Uso de variables

¿Qué son las variables?#

Alcances de las variables#

Valores compartidos y locales#

Uso de variables en Apidog CLI#

Definición de variables#

1. Gestión de entornos (predefinida)#

2. Extraer variables#

3. Scripts#

4. Operaciones de base de datos#

Uso de variables#

Parámetros de la petición#

Acceso a subelementos#

Uso de variables en scripts#

Uso de variables de datos#

Preguntas frecuentes#

¿Qué son las variables?

Alcances de las variables

Valores compartidos y locales

Uso de variables en Apidog CLI

Definición de variables

1. Gestión de entornos (predefinida)

2. Extraer variables

3. Scripts

4. Operaciones de base de datos

Uso de variables

Parámetros de la petición

Acceso a subelementos

Uso de variables en scripts

Uso de variables de datos

Preguntas frecuentes