Manual práctico para probar API online

Una interfaz de programación de aplicaciones (API) es un software mediante el cual las aplicaciones y los servicios pueden interactuar entre sí. Se trata de una interfaz que facilita la transferencia de datos y lógica entre varios sistemas de hardware y software. 

Por ejemplo, una aplicación de banca móvil utiliza una API para acceder a la cámara de tu teléfono celular, de manera que puedas tomar una foto de un cheque y depositarlo en tu cuenta de forma remota.

Sin las API, las interacciones digitales continuas de las que participamos todos los días con nuestras computadoras, teléfonos inteligentes, televisiones y otros dispositivos no serían posibles.

¿Qué son las pruebas de API?

Con las pruebas de API, los desarrolladores pueden determinar si las API cumplen con las expectativas de funcionalidad, rendimiento, fiabilidad y seguridad. El objetivo es detectar errores y otros comportamientos inesperados para que los usuarios no reciban un producto poco seguro o de mala calidad. Es necesario asegurarse de que la API que se lanza al mercado funcione de manera eficiente y efectiva. De otro modo, nadie la utilizará.

Sin embargo, las pruebas de API pueden no ser tan simples como parece. Por lo general, las API utilizan protocolos y estándares con los que es probable que no trabajes normalmente. Estos protocolos y estándares se necesitan para que distintas plataformas, aplicaciones y sistemas puedan interactuar entre sí. Entonces, para crear una interfaz confiable, no solo se debe probar la funcionalidad de la API, sino también el rendimiento, la seguridad y el trabajo conjunto de todos los componentes.

¿Por qué deberías realizar pruebas de API?

Entre otras cosas, las API nos ayudan en nuestro trabajo diario y nos permiten encontrar información importante. De acuerdo con un informe del estado de Internet de Akamai, las llamadas a las API constituyen el 83 % del tráfico en la Web. Como las API son tan importantes para la vida cotidiana de los usuarios, realizar pruebas en ellas debería ser una prioridad por los siguientes motivos:  

• Independencia del lenguaje: las API utilizan formatos como XML y JSON para intercambiar datos. Por lo tanto, son independientes del lenguaje, lo que permite utilizar cualquier lenguaje para automatizar las pruebas. 
• Independientes de una interfaz gráfica de usuario (GUI): las API pueden probarse sin una interfaz de usuario para revisar la funcionalidad principal de la aplicación y encontrar fallas o errores.
• Mejor cobertura de pruebas: las API incluyen características con las que puedes crear scripts de automatización con una cobertura mayor. 
• Reducción del costo de las pruebas: con las pruebas de API, puedes encontrar errores pequeños en las funciones principales antes de que se prueben en la GUI. Potencialmente, estos errores pequeños pueden convertirse en grandes problemas durante las pruebas de GUI, por lo que encontrarlos y corregirlos durante las pruebas de API permite ahorrar mucho tiempo y dinero.
• Lanzamiento más rápido de productos: las pruebas de API suelen tardar una fracción del tiempo que lleva realizar una prueba de regresión de la interfaz de usuario (UI) completa. Por eso, permite detectar y corregir errores de forma más rápida y eficiente, y las nuevas creaciones pueden lanzarse más rápido.
• Confirmación del funcionamiento correcto de las API: con las pruebas, puedes asegurarte de que las API funcionen como deben.
• Confirmación de que las API pueden soportar la carga: puedes realizar pruebas que apliquen la cantidad de tráfico que se espera que la API soporte. Es una forma de simular la actividad de varios usuarios que envían solicitudes simultáneas para ver qué tan sólida es tu aplicación. 
• Prueba de compatibilidad: debes probar las API para asegurarte de que sean compatibles con todos los dispositivos, navegadores y sistemas operativos.
• Previsión de errores de usuarios: con las pruebas, puedes predecir los potenciales errores de los usuarios. Si tienes esta información, podrás anticipar los errores de los usuarios y mejorar el diseño.

¿Quieres obtener más información sobre el desarrollo de una API? Lee el artículo ”Cómo crear una API” (disponible en inglés).

¿Cuáles son las herramientas y como probar web apis?

Como con cualquier proyecto de tecnología, no puedes comenzar a probar una API sin antes elaborar un plan. Esto te ayudará a determinar tus objetivos y las formas en que puedes alcanzarlos. A continuación, incluimos algunos consejos para que comiences el proceso de analisis depruebas de una API.

• Comprender los requisitos: registra los requisitos de la API y responde las siguientes preguntas:

• ¿Cuál es el propósito de la API?
• ¿Cuál es la audiencia objetivo?
• ¿Qué problemas se probarán?
• ¿Cuál es el resultado esperado?
• ¿Cuáles son las características y las funciones de la API?
• ¿Cuál es el flujo de trabajo de la aplicación?
• ¿Qué integraciones son compatibles con la API?
• ¿Cuáles son las prioridades de prueba?

• Establecer tu entorno de prueba: establece tu entorno de prueba en función de los requisitos de la API. Configura la base de datos y el servidor para que se ajusten a los requisitos de la aplicación. A continuación, haz una llamada a la API para asegurarte de que todo esté correctamente configurado y no se produzca ningún error antes de comenzar con la prueba.
• Elegir las herramientas de prueba de API: a menos que planees hacer una prueba manual, deberás elegir una herramienta de prueba de API para poder estructurar y administrar los casos de prueba.
• Decidir qué tipos de pruebas de API se realizarán: una vez que hayas establecido tu entorno de prueba y te hayas asegurado de que todo funcione, deberás decidir qué pruebas realizarás. 

¿Qué tipos de pruebas de API puedes realizar?

El tipo de prueba dependerá de lo que quieras probar. Por ejemplo, si quieres probar características y funciones, puedes realizar una prueba funcional.

Hay varios tipos diferentes de pruebas de API de los que puedes elegir. 

• Pruebas funcionales: se prueban diferentes funciones en la base de código. Las pruebas representan situaciones específicas para garantizar que las funciones de la API se ejecuten conforme a los parámetros esperados y planificados.
• Prueba de fiabilidad: en este tipo de prueba, se revisa si la API puede funcionar sin errores durante un período específico y en un entorno determinado.
• Prueba de carga: se controla el rendimiento de la API en condiciones normales y de carga máxima.
• Prueba de seguridad: se utiliza para garantizar que la API esté protegida contra amenazas externas. En esta prueba, se emplean metodologías de cifrado, control de acceso a la API, administración de derechos de usuarios y validación de autorizaciones.
• Prueba de UI: se prueba la UI de la API. Esta prueba se centra en la interfaz que se asocia a la API, en lugar de la API en sí misma. A partir de las pruebas de UI, se puede obtener información general sobre el estado y la factibilidad de uso en el front-end y el back-end.
• Pruebas negativas: el propósito de una prueba negativa es determinar qué sucede cuando la aplicación recibe una entrada no válida o no intencional. Se intenta descubrir qué puede hacer que el sistema falle para desarrollar respuestas más adecuadas. Por ejemplo, si se escribe una letra en un campo numérico, esto debería activar un mensaje de advertencia y no debería provocar que la aplicación falle. 
• Prueba de validación: este tipo de prueba se realiza para verificar que la API se haya desarrollado correctamente y que funcione por completo.

Pruebas de API manuales frente a pruebas automatizadas

Las pruebas manuales son procesos prácticos en los que un profesional de control de calidad realiza pruebas individuales de a una por vez. En cada parte del proceso, desde la creación del caso de prueba hasta su ejecución, se utilizan programas de prueba. Con ellos, se validan las características, se buscan errores y se elaboran informes de errores sin utilizar herramientas de automatización.

Las pruebas manuales llevan más tiempo y pueden ser tediosas. Con la automatización, se pueden ejecutar más casos de prueba, mejorar la cobertura de prueba y, en general, llevar adelante un proceso más eficiente. 

¿Por qué puedes realizar pruebas API manuales?

En las pruebas manuales, la atención se centra en el proceso de prueba. Si creas y ejecutas tus propias pruebas de forma manual, tienes un control más preciso de la prueba. Además, se corre un riesgo más bajo de que las pruebas presenten resultados falso negativos, lo que generaría más trabajo, ya que debería verificarse si los errores informados son verdaderos o no.

Es conveniente utilizar procesos manuales para los siguientes tipos de pruebas.

• Pruebas exploratorias
• Pruebas de usabilidad
• Pruebas de UI
• Pruebas ad hoc

También puedes realizar pruebas manuales para observar cambios pequeños. Para ejecutar una prueba automatizada en este caso, incluso los cambios más pequeños requerirían que se escriba un código nuevo, lo que representaría una pérdida de tiempo en comparación con una prueba manual rápida. 

¿Por qué puedes utilizar pruebas de API automatizadas?

La principal ventaja de la automatización de las pruebas de API es que pueden realizarse más pruebas en menos tiempo. Permite aumentar la productividad y hace que el proceso de prueba resulte más eficiente. Si las pruebas se realizan de forma más rápida y también se introducen más rápidamente las correcciones, por lo que el producto se lanza antes al mercado.

Los procesos automatizados deberían utilizarse para los siguientes tipos de pruebas.

• Pruebas funcionalefs
• Pruebas de carga
• Pruebas de rendimiento
• Pruebas de validación
• Pruebas dinámicas
• Pruebas basadas en datos
• Pruebas de errores
• Pruebas de varios lenguajes
• Pruebas de regresión

¿Cuáles son algunas de las prácticas recomendadas respecto de las pruebas de web API online?

Si bien las pruebas de UI y exploratorias deberían ser manuales, la mayoría de las pruebas de API requieren automatización. A continuación, se mencionan algunas prácticas recomendadas para la realización de pruebas de API automatizadas. Si adoptas estas prácticas, podrás optimizar las pruebas, realizar más pruebas en menos tiempo, ahorrar dinero y lanzar productos de mejor calidad.

Regístralo todo

El éxito de las pruebas puede estar determinado por la precisión con la que se definen los requisitos de negocio y los casos de prueba. La mayoría de las API no tienen una GUI de front-end a la que se pueda hacer referencia, por lo que es esencial contar con documentación en la que se especifique cada campo y sus parámetros asociados con claridad. Los programas de prueba hacen referencia a los documentos para garantizar que se cubran todos los casos de uso necesarios.

Además, se deben elaborar informes de pruebas integrales y detallados en los que se registren los motivos de los errores de las pruebas. Con estos informes, resulta más sencillo para los desarrolladores determinar qué aspectos deben corregirse.

Aplica del enfoque DRY

El enfoque de no repetición (DRY) se aplica para evitar la repetición de código. Si el código se asemeja a los componentes y las acciones de varias API, se puede almacenar en una biblioteca común con el fin de que sea de fácil acceso para lo que sea que se necesite.

Comienza por las API pequeñas

Para acostumbrarte a la rutina de prueba, comienza por API simples que tengan solo una o dos entradas (por ejemplo, una API de inicio de sesión). De esta manera, ganarás confianza y te asegurarás de que tu entorno de prueba funcione de forma adecuada antes de abordar las API más grandes.