Apidog es una plataforma de colaboración y desarrollo de API que ayuda a los equipos de backend, frontend y control de calidad a trabajar de forma más eficiente. Para los ingenieros de control de calidad, Apidog ofrece una variedad de funciones de prueba, incluidas las pruebas unitarias, las pruebas de integración, las pruebas basadas en datos, las pruebas de rendimiento, las pruebas de regresión, CI/CD y la supervisión programada.
Repasemos el flujo de trabajo completo para los ingenieros de control de calidad que utilizan Apidog, comenzando con lo básico.
Preparación inicial
El primer paso para comenzar las pruebas de API es obtener documentación detallada de la API. Apidog facilita esto al permitirle importar documentación de API existente directamente. Esto elimina la necesidad de ingresar cada punto final manualmente. Simplemente vaya a Project Settings -> Import Data y elija el formato de datos apropiado para importar.
Pruebas unitarias
Las pruebas unitarias son una parte crucial del proceso de prueba. Garantiza que cada API funcione como se espera en diferentes condiciones. Los ingenieros de control de calidad escriben casos de prueba detallados para cubrir varios escenarios, como casos normales, excepcionales y límite. Esto garantiza que la API maneje todas las entradas posibles.
Por ejemplo, el punto final "Consultar detalles de la mascota" requiere un ID de mascota como parámetro para recuperar los detalles de la mascota. Los ingenieros de control de calidad pueden ingresar petId=123 en la página "Ejecutar" de Apidog y enviar la solicitud. Luego, pueden verificar si se devuelven los detalles correctos de la mascota.
Para automatizar la prueba, se pueden agregar aserciones en los post-procesadores. Estas aserciones verifican si el ID de mascota correcto aparece en la respuesta en el campo data. Al usar la expresión JSONPath $.data.id y configurar la aserción en Exists, el ID de la mascota se puede extraer y validar automáticamente.
También puede extraer la aserción directamente de la respuesta devuelta.
Una vez que se completan estos pasos, se puede guardar el caso de prueba. Se pueden crear casos de prueba normales y anormales adicionales según sea necesario, como "Mascotas disponibles para la venta", "Mascotas vendidas", "Registro no encontrado" y "Formato de ID incorrecto". Estos casos de prueba guardados se pueden ejecutar rápida y fácilmente en futuras pruebas de regresión para verificar la estabilidad de las funcionalidades principales.
Pruebas de integración
Probar las API individuales es importante, pero las aplicaciones reales a menudo requieren que varias API trabajen juntas. Las pruebas de integración garantizan que estas API interactúen correctamente. Simula las acciones reales del usuario y prueba el intercambio de datos y el flujo de trabajo entre las API.
Por ejemplo, en un proceso de compra de mascotas, los usuarios pueden buscar listas de mascotas, agregar mascotas al carrito, realizar un pedido, realizar un pago y ver los detalles del pedido. Los ingenieros de control de calidad pueden crear un escenario de prueba en Apidog, agregando casos de prueba para cada punto final involucrado en el proceso.
La transferencia de datos entre puntos finales es crucial para garantizar que el proceso de prueba esté completo. Tomemos como ejemplo el flujo de compra de mascotas. Los ingenieros de control de calidad pueden pasar el ID del pedido entre los pasos de dos maneras:
- Método 1: Después de ejecutar el punto final "Crear pedido", guarde el ID de pedido generado como una variable y utilícelo en los puntos finales de pago y consulta de pedido posteriores.
- Método 2: Utilice directamente el valor de retorno del punto final "Crear pedido" en los puntos finales de pago y consulta de pedido (este método es más fácil y recomendado).
Para operaciones por lotes, como agregar varias mascotas al carrito, se puede agregar un bucle ForEach. Configure la matriz de bucle en la lista de mascotas.
El ID de la mascota se insertará automáticamente, lo que facilitará las operaciones masivas.
Después de configurar todo, ejecute el escenario de prueba. Esto generará un informe de prueba detallado. Los ingenieros de control de calidad pueden encontrar y solucionar rápidamente cualquier problema.
Pruebas basadas en datos
En algunos casos, el mismo punto final debe probarse con múltiples conjuntos de datos. La función de prueba basada en datos de Apidog ayuda con esto. Los ingenieros de control de calidad pueden importar un archivo CSV que contenga diferentes conjuntos de datos. Estos conjuntos se pueden usar en el escenario de prueba para ejecutar pruebas automáticamente.
Así es como funciona: los ingenieros de control de calidad crean un nuevo escenario de prueba, agregan el punto final "Crear información de mascota" e importan el archivo CSV en los Test Data. Cada fila (con la primera fila como nombre de variable) en el archivo CSV representa un conjunto de datos que se puede usar en la solicitud de API.
Haga referencia a estas variables en el cuerpo JSON de la solicitud del punto final para asignar los datos del archivo CSV.
Seleccione los datos de prueba y el entorno apropiados, y luego ejecute la prueba. Apidog ejecutará automáticamente los casos de punto final para cada conjunto de datos, generando el estado de ejecución e informes para cada ronda.
Al automatizar las pruebas masivas de esta manera, Apidog mejora significativamente tanto la eficiencia como la precisión del proceso de prueba.
Pruebas de rendimiento
Una vez que se valida la funcionalidad básica de un punto final, el siguiente paso son las pruebas de rendimiento. Esto verifica cómo se comporta el sistema bajo tráfico pesado. Apidog proporciona herramientas de prueba de rendimiento que simulan múltiples usuarios virtuales para probar la respuesta del sistema.
Por ejemplo, en un escenario de pedido, los ingenieros de control de calidad pueden establecer el número de usuarios virtuales (por ejemplo, 10), la duración de la prueba y el tiempo de aceleración (por ejemplo, 1 minuto). Durante la prueba, Apidog genera gráficos en tiempo real que muestran métricas clave como las solicitudes por segundo, el tiempo de respuesta del servidor y las tasas de error. Esto ayuda a los ingenieros de control de calidad a identificar los cuellos de botella de rendimiento y optimizar en consecuencia.
Pruebas de regresión
A medida que los sistemas evolucionan, las nuevas funciones pueden afectar la funcionalidad existente. Las pruebas de regresión garantizan que las nuevas actualizaciones no interrumpan las funciones principales. En Apidog, los ingenieros de control de calidad pueden crear una carpeta de prueba de regresión y agregar escenarios de prueba clave. Antes de cada lanzamiento, pueden ejecutar estas pruebas de forma masiva para asegurarse de que todo funcione como se espera.
Integración de CI/CD
En los flujos de trabajo de desarrollo modernos, la Integración Continua (CI) y la Implementación Continua (CD) son cruciales para mantener ciclos de lanzamiento rápidos y código de alta calidad. Apidog se integra perfectamente con herramientas de CI/CD como Jenkins, lo que permite que las pruebas automatizadas se ejecuten como parte de la canalización de compilación.
Los ingenieros de control de calidad pueden ir a la página CI/CD en un escenario de prueba específico, seleccionar el entorno y los datos de prueba apropiados y habilitar las notificaciones para los resultados de la prueba (admite varios métodos de notificación, como correo electrónico, Slack, Webhook y Jenkins, etc.). A continuación, seleccione la herramienta de CI/CD correspondiente, copie el comando generado y configúrelo en Jenkins u otra herramienta de compilación.
Es importante generar y configurar el Access Token durante el proceso de integración para garantizar una autenticación y comunicación fluidas con Jenkins. Una vez configurado, Apidog ejecutará automáticamente las pruebas cada vez que se active una compilación y enviará los resultados de la prueba al equipo a través del método de notificación seleccionado, lo que mejorará la eficiencia de la colaboración.
Tareas programadas para pruebas de API
A veces, es necesario ejecutar pruebas de forma regular para garantizar que el sistema permanezca estable. La función de tareas programadas de Apidog permite a los ingenieros de control de calidad automatizar este proceso. Pueden programar pruebas para que se ejecuten en momentos específicos y recibir notificaciones sobre los resultados.
Antes de usar esta función, los ingenieros de control de calidad deben instalar Apidog's Runner en el servidor. Esto garantiza que las tareas programadas puedan ejecutarse de forma independiente en el servidor sin depender de que la computadora local esté encendida. Después de la instalación, los ingenieros de control de calidad pueden crear una nueva tarea programada, seleccionar el escenario de prueba, configurar el modo de ejecución y el servidor, y habilitar las notificaciones.
Después de que se ejecuta la tarea, Apidog registra los resultados y los envía al equipo, lo que ayuda a detectar y solucionar rápidamente cualquier problema.
Conclusiones finales
Apidog proporciona un conjunto completo de funciones que agilizan significativamente el ciclo de vida de las pruebas de API, desde la preparación inicial hasta la supervisión continua. Con sólidas capacidades en pruebas unitarias, de integración, basadas en datos, de rendimiento, de regresión y de CI/CD, así como tareas programadas, Apidog garantiza pruebas de API eficientes, fiables y escalables. Al integrar Apidog en sus flujos de trabajo de prueba, los equipos pueden ahorrar tiempo, reducir errores y ofrecer API de alta calidad más rápido, lo que lleva a una mejor estabilidad y rendimiento del sistema.
