How to Submit a Request to REST Web API
Tipo de solicitud
La prueba de API web de REST admite diferentes métodos HTTP que se pueden usar de acuerdo con los objetivos de prueba. Al seleccionar una solicitud GET, simplemente se recuperarán datos de la API web. Aunque los parámetros de solicitud se pueden incluir en la dirección URL, se recomienda utilizar métodos dedicados para insertar la carga en una API.
To send any custom information, change data, or trigger any flow or event, use such request types as POST, PUT, or PATCH. En este caso, para especificar el cuerpo de la solicitud, vaya a la sección Publicar datos.
Si establece el tipo de solicitud en POST, PUT o PATCH, pero no especifica los parámetros de solicitud en la sección Registrar datos, el tipo de solicitud se volverá a cambiar a GET al guardar la tarea.
Autenticación
Si la API requiere autenticación, proporcione las credenciales en la sección Autenticación básica. Si la autenticación basada en token es el método utilizado, siga las recomendaciones proporcionadas para las API basadas en OAuth 2.0 y configure los parámetros de autenticación de forma similar.
Datos de publicación
En esta sección, puede proporcionar fácilmente cualquier entidad de solicitud, como JSON.
Para especificar el cuerpo de la solicitud, simplemente pegue o escriba contenido JSON en el campo. El sistema analizará automáticamente el código y se le pedirá que seleccione un encabezado de tipo de contenido basado en el tipo de cuerpo de la solicitud. Además, puede proporcionar un encabezado de tipo de contenido personalizado si es necesario.
Una vez especificado, el tipo de contenido se agregará automáticamente a la sección Encabezados.
Creación de una colección de solicitudes
Puede enviar tantas solicitudes dentro de una prueba como desee. Tenga en cuenta que todas las solicitudes deben agregarse a la prueba en el orden en que deben ejecutarse.
Para configurar una prueba de varias solicitudes:
- En primer lugar, cree y guarde una nueva prueba de Rest Web API.
- Para configurar una secuencia de solicitudes dentro de la prueba, en la lista de pruebas, en el menú de acciones de la
prueba, seleccione Agregar destino. - Configure la configuración de la solicitud y guarde los cambios. Las solicitudes se mostrarán en la barra lateral de la pantalla de edición del dispositivo en el orden en que se ejecutarán. Para acceder a los parámetros de solicitud, seleccione el elemento correspondiente en la barra lateral.
- Para agregar la siguiente solicitud desde la interfaz de edición del dispositivo, haga clic en el botón “más” en la barra lateral.
Para obtener más información sobre la configuración y supervisión de dispositivos de varios destinos, consulte Adición de varios destinos dentro de un único dispositivo.
Validación de resultados
En general, no es suficiente simplemente realizar una llamada a una API, el propósito de asegurarse de que la respuesta de la API contiene datos que se esperaba recibir. Para verificar la respuesta de la API, es suficiente encontrar algunas palabras clave que coincidan exactamente en la respuesta. Conociendo el contenido de la respuesta de la API, puede proporcionar las palabras clave en la sección Validación de contenido. Para obtener más información, consulte el artículo Palabra clave.
Casos de uso
Consideremos una API REST de correo electrónico como un ejemplo. Para supervisar el servicio, necesitamos enviar la solicitud POST al punto de conexión de API correspondiente, junto con los detalles de correo electrónico en el cuerpo de la solicitud. Para ello, tenemos que proporcionar la dirección URL del punto de conexión y seleccionar el tipo de solicitud POST.
Dado que la API REST de correo electrónico requiere autenticación básica, también necesitamos proporcionar las credenciales en la sección correspondiente.
En la sección Post Data, especificaremos la matriz JSON con detalles de correo electrónico y seleccionaremos el tipo de encabezado para insertar la carga en el punto de conexión de la API.
El siguiente paso es especificar una palabra clave que se buscará en la respuesta de la API para su validación.
-
Supervisión de la API de REST
La mayoría de las aplicaciones web modernas utilizan una API REST para comunicarse con el servidor e integrarse entre sí. Garantizando la calidad adecuada de los datos en la API, garantizamos la calidad de todo el servicio web que los utiliza.
Supongamos que ha creado la API RESTful para su servicio web, y es necesario controlar que todas las funciones de la API funcionan correctamente y están disponibles las 24 horas del día, los 7 días de la semana. Pero, ¿por qué necesitamos probar una API WEB, no es más fácil probar una interfaz de usuario en busca de problemas? Analicemos las ventajas más comunes de las pruebas y supervisión de API.
La primera ventaja de las pruebas de la API de REST es que ayuda a identificar un origen determinado de un problema. Al probar la API, puede encontrar qué función específica se ejecuta con errores.
Además, con las pruebas de API no es necesario crear un entorno de prueba dedicado para probar la funcionalidad del servicio web. Frente a las pruebas de interfaz de usuario que requieren una cadena de acciones de usuario en una ventana del explorador para enviar una solicitud a un servidor web, las pruebas y la supervisión de la API se pueden realizar mediante herramientas automatizadas para enviar una solicitud de punto de conexión específica. Por ejemplo, este enfoque le permite omitir dicho problema, ya que se producen errores de prueba falsos en el nivel GUI.
Aunque puede probar todas las funciones de la API manualmente, es un proceso difícil y lento. Además, cada vez que realice cambios o agregue nuevas características a la API, las pruebas deben volver a ejecutarse para asegurarse de que las actualizaciones no han afectado a la funcionalidad de la API. La supervisión automatizada de la API REST permite evitar las desventajas de las pruebas manuales y puede llevar su rutina de supervisión de API al siguiente nivel.
Supervisión de la API REST con Dotcom-Monitor
Dotcom-Monitor ofrece dos opciones para la supervisión automatizada del rendimiento de la API:
- El dispositivo de supervisión de la API web de REST.
- El dispositivo de monitoreo postman Collection.
Para configurar la prueba de supervisión de la API RESTful desde cero, se recomienda utilizar nuestro dispositivo de supervisión de la API web REST. Este tipo de dispositivo de supervisión le permite configurar una solicitud HTTP simple a un punto de conexión de API con una autenticación básica y parámetros POST.
En caso de que ya haya utilizado Postman para ejecutar las pruebas de sus servicios de API RESTful, se recomienda importar su colección Postman a Dotcom-Monitor. Una vez que la colección de solicitudes de Postman se importó al sistema, puede configurar el dispositivo de supervisión Postman Collection para automatizar la supervisión de los servicios de API.
Aunque el dispositivo REST Web API admite la ejecución de varias solicitudes, en algunos casos puede ser complicado de configurar. A su vez, si está familiarizado con la herramienta, Postman es ideal para configurar solicitudes HTTP parametrizadas y pruebas de aserción para la supervisión de REST Web API.
Por lo tanto, si desea crear una prueba con una secuencia complicada de llamadas a la API o cuando se requiere una autenticación distinta de la autenticación básica, utilice Postman para crear una colección de llamadas a la API. A continuación, simplemente impórtelo al dispositivo Dotcom-Monitor Postman Collection y configure la supervisión como se describe en Postman Monitoring (Tareas de cobro) con las API de Dotcom-Monitor. Dotcom-Monitor ejecutará llamadas API con una frecuencia especificada (hasta 1 min), generará informes y enviará notificaciones de error de supervisión a una dirección proporcionada.
¡Asegúrese de echar un vistazo a nuestro conjunto completo de herramientas de monitoreo de API en Dotcom-Monitor para ayudar a garantizar la confiabilidad de las aplicaciones y servicios web!