Qué herramienta usar para pruebas de API basadas en datos con CSV o JSON

Probar un endpoint de API una vez es sencillo. Envías una solicitud, revisas la respuesta y confirmas que todo funciona como se espera. El verdadero desafío comienza cuando necesitas ejecutar la misma prueba contra docenas, o incluso cientos, de diferentes conjuntos de datos. Actualizar manualmente los parámetros y enviar solicitudes repetidamente no solo consume mucho tiempo, sino que también es propenso a errores e imposible de escalar.

Aquí es donde entra en juego la prueba de API basada en datos. En lugar de reescribir o reenviar solicitudes manualmente, defines un único caso de prueba y lo ejecutas automáticamente con múltiples conjuntos de datos de entrada. El resultado es una cobertura más amplia, mayor precisión y mucho menos esfuerzo manual.

Para hacer esto de manera eficiente, necesitas la herramienta adecuada. Apidog se destaca por ofrecer soporte nativo para pruebas basadas en datos utilizando archivos CSV y JSON. Como plataforma todo en uno para el desarrollo y prueba de API, Apidog te permite vincular archivos de datos externos a un escenario de prueba y ejecutarlo repetidamente, validando cada respuesta automáticamente.

Ya sea que estés probando flujos de inicio de sesión con diferentes usuarios, API de búsqueda con consultas variadas o la creación de recursos con múltiples combinaciones de parámetros, Apidog elimina el trabajo repetitivo y te ayuda a lograr pruebas de API confiables y completas en una fracción del tiempo.

Ahora, profundicemos en una guía completa y paso a paso para dominar las pruebas de API basadas en datos usando Apidog con CSV y JSON.

Guía paso a paso para pruebas de API basadas en datos con CSV y JSON

Recorramos todo el proceso, desde la configuración hasta la ejecución, utilizando un ejemplo concreto. Probaremos un endpoint de API de registro de usuarios.

Paso 1: Define tu Solicitud Base de API

Primero, creas la solicitud de API que servirá como tu plantilla de prueba.

1. En Apidog, crea una nueva solicitud a tu endpoint de registro de usuarios (ej., POST /api/v1/users).
2. Configura los encabezados (ej., Content-Type: application/json).
3. En la pestaña Body, crea tu payload JSON. En lugar de codificar valores fijos, usarás la sintaxis de variables dinámicas de Apidog {{}} para crear marcadores de posición.

{
  "username": "{{username}}",
  "email": "{{email}}",
  "password": "{{password}}",
  "role": "{{role}}"
}

Observa los marcadores de posición: {{username}}, {{email}}, etc. Apidog los reemplazará con valores reales de tu archivo de datos durante la ejecución.

Paso 2: Crea tu Archivo de Datos de Prueba (CSV o JSON)

Ahora, crea el archivo externo que alimentará los datos a tus marcadores de posición.

Opción A: Usando un Archivo CSV

CSV es perfecto para datos tabulares. Crea un archivo user_data.csv:

username,email,password,role,expected_status
john_doe,john@example.com,SecurePass123!,user,201
jane_smith,jane@example.com,AnotherPass456!,admin,201
bad_user,not-an-email,short,user,400
duplicate_user,john@example.com,SomePass789!,user,409

• La primera fila define los nombres de las variables que coinciden con tus marcadores de posición (username, email, etc.), además de un expected_status adicional para la validación.
• Cada fila subsiguiente es un caso de prueba con los datos para esa ejecución.

Opción B: Usando un Archivo JSON

JSON es ideal para estructuras de datos anidadas o más complejas. Crea un archivo user_data.json:

[
  {
    "username": "john_doe",
    "email": "john@example.com",
    "password": "SecurePass123!",
    "role": "user",
    "expected_status": 201
  },
  {
    "username": "jane_smith",
    "email": "jane@example.com",
    "password": "AnotherPass456!",
    "role": "admin",
    "expected_status": 201
  },
  {
    "username": "bad_user",
    "email": "not-an-email",
    "password": "short",
    "role": "user",
    "expected_status": 400
  }
]

Paso 3: Configura la Prueba Basada en Datos en Apidog

Aquí es donde el flujo de trabajo integrado de Apidog brilla.

1. Ve a la pestaña "Test" (Prueba) dentro de tu panel (o crea un nuevo caso de prueba en una suite de pruebas).

2. Haz clic para añadir un nuevo paso de prueba y selecciona tu solicitud POST /api/v1/users.

3. Cargar datos de prueba: Haz clic en "Test Data" (Datos de Prueba) > "+New" (Nuevo) para cargar tu archivo user_data.csv o user_data.json. Apidog lo analizará y te mostrará una vista previa de las filas de datos.

4. Mapear Variables (si es necesario): Apidog mapea automáticamente los nombres de columna (CSV) o las claves de propiedad (JSON) a los marcadores de posición {{variable}} en tu solicitud. Verifica que el mapeo sea correcto.

Paso 4: Escribe Aserciones Usando tus Variables de Datos

El verdadero poder proviene de validar resultados esperados diferentes basándose en tus datos de entrada. En la pestaña Test (Prueba), escribes aserciones (también llamadas "asserts" o "verificaciones").

Fundamentalmente, puedes referenciar las mismas variables de datos de tu archivo en tus aserciones.

Por ejemplo, añade una aserción de Código de Estado de Respuesta:

• Valor esperado: {{expected_status}}

Esto significa: "Para la primera ejecución de prueba (john_doe), afirma que el código de estado es igual a 201. Para la tercera ejecución (bad_user), afirma que es igual a 400." La aserción cambia dinámicamente con cada iteración.

Puedes añadir aserciones más complejas usando JavaScript en la sección Script de Apidog:

// Ejemplo: Validar el cuerpo de la respuesta para una creación exitosa
pm.test("Status code is " + pm.variables.get("expected_status"), function () {
    pm.response.to.have.status(pm.variables.get("expected_status"));
});

// Solo verificar el ID de usuario si esperamos una creación exitosa
if (pm.variables.get("expected_status") === 201) {
    pm.test("Response has user ID", function () {
        var jsonData = pm.response.json();
        pm.expect(jsonData.id).to.be.a('number');
        pm.expect(jsonData.username).to.eql(pm.variables.get("username"));
    });
}

Paso 5: Ejecuta la Prueba y Analiza los Resultados

Haz clic en el botón Run (Ejecutar). Apidog ejecutará tu único paso de prueba múltiples veces, una vez por cada fila en tu archivo de datos.

El Informe es Donde Todo se Une:

Apidog presenta un informe claro y agregado que muestra:

• Iteraciones Totales: (ej., "4/4 Aprobado")
• Un desglose para cada fila de datos: Puedes expandir para ver la solicitud exacta enviada (con los valores sustituidos reales) y la respuesta recibida para esa iteración específica.
• Cualquier fallo se señala a la fila específica de datos que causó el problema. ¿Falló duplicate_user porque el estado no era 409? Lo verás al instante.

Esto hace que la depuración sea increíblemente eficiente. No tienes que adivinar qué caso de prueba falló; sabes que fue la iteración con el conjunto de datos específico {"username": "duplicate_user", ...}.

Mejores Prácticas para Pruebas de API Basadas en Datos

1. Datos Específicos del Entorno: Combina las pruebas basadas en datos con los Entornos de Apidog. Podrías tener una variable base_url en tu entorno que cambia de staging a producción, mientras que tu archivo CSV contiene los casos de prueba aplicables a ambos.
2. Datos de Prueba Reutilizables: Almacena tus archivos CSV/JSON en un lugar central dentro de tu proyecto Apidog. Múltiples suites de pruebas pueden referenciar el mismo archivo de datos, asegurando la consistencia.
3. Generar Archivos de Datos Programáticamente: Para escenarios complejos, usa un script (Python, Node.js) para generar tu archivo test_data.csv. Esto es excelente para probar con datos aleatorios o un gran rango de valores (ej., probar paginación con 100 combinaciones diferentes de page y limit).
4. Configuración/Limpieza de Pruebas: Usa los scripts de pre-solicitud y las funciones de limpieza de pruebas de Apidog junto con las pruebas basadas en datos. Por ejemplo, antes de cada iteración de una prueba DELETE, podrías usar un script de pre-solicitud para crear el recurso que será eliminado.

Conclusión: Transforma tu Flujo de Trabajo de Pruebas de API

Las pruebas basadas en datos en Apidog con archivos CSV/JSON te llevan de la verificación manual y repetitiva a la validación automatizada y exhaustiva. Encarna el principio central de las buenas pruebas: ser exhaustivo sin sacrificar la eficiencia.

Al externalizar tus datos de prueba, creas un documento vivo de escenarios de prueba que es fácil de leer, actualizar y comprender para cualquier miembro de tu equipo. La integración perfecta de esta metodología en Apidog significa que no hay una configuración compleja, solo un camino directo hacia APIs más confiables.

Deja de probar APIs caso por caso. Descarga Apidog gratis hoy, importa tu primer archivo CSV y experimenta cuán potente y eficiente puede ser realmente la prueba de API.