Fuente de Datos REST¶

Descripción General¶

La fuente de datos REST ofrece a los desarrolladores la posibilidad de conectar Vinyl a varios servidores REST, incluidas otras instancias de Vinyl. Configurar una fuente de datos REST implica tres pasos básicos:

Crear y configurar el servidor de fuente de datos REST
Crear extremos REST para cada método API que llamará
Para APIs de estilo REST CRUD, opcionalmente crear un superobjeto REST

Servidor de Origen de Datos REST¶

La configuración del servidor de origen de datos REST contiene información que se utiliza en todos los extremos REST.

Crear el Servidor de Datos REST¶

Vaya a IDE > Servidores de datos
Haga clic en + Servidor
Ingrese un Nombre del servidor
Seleccione Tipo API REST en Servicios web
Ingrese la URL del servidor al que conectarse

Nota

Los Extremos que configure en la siguiente sección se agregarán a esta URL principal. Si asumimos un extremo del servidor REST de https://api.google.com/rest/v1/analytics la configuración podría verse así:

URL del servidor: https://api.google.com/rest/v1 Extremo: analytics
Ingrese el tipo de contenido de solicitud y respuesta. Normalmente los servidores REST se comunican a través de JSON.
Ingrese Configuración de seguridad, si es necesario
- La mayoría de las APIs REST utilizan una clave API en el encabezado que configuramos en una sección posterior.
Haga clic en Guardar y cierre el cuadro de diálogo.

Debería ver su servidor de datos REST en la lista de servidores de datos.

Configurar Encabezados de Solicitud¶

La mayoría de los servicios REST requieren que usted pase una clave API usando el encabezado de solicitud. Configure el encabezado de la solicitud de la siguiente manera:

Vaya a IDE > Servidores de datos
Haga clic en el botón Detalles del servidor de datos que configuró.
En el panel Parámetros del servicio web, haga clic en + Parámetro
- Seleccione Encabezado como Tipo
- Agregue el Nombre del parámetro del encabezado
  - Por ejemplo, para servidores REST de Vinyl, la clave API se pasa mediante "X-API-Key"
Agregue el Valor del parámetro del encabezado
Haga clic en el icono de marca de verificación para guardar

Configurar Parámetros de Cadena de Consulta¶

Si tiene parámetros de cadena de consultar comunes para usar en todos los puntos finales, puede configurarlos de la siguiente manera:

Vaya a IDE > Servidores de datos
Haga clic en el botón Detalles del servidor de datos que configuró.
En el panel Parámetros del servicio web, haga clic en + Parámetro
- Seleccione Consulta como tipo
- Agregue el Nombre del parámetro de cadena de consultar
- Agregue el Valor del parámetro de cadena de consultar
Haga clic en el icono de marca de verificación para guardar

Extremos REST¶

Una vez que se haya configurado su servidor de datos REST, puede agregar extremos de API.

Agregar un Extremo¶

Vaya a IDE > Servidores de datos
Haga clic en el botón Detalles del servidor de datos que configuró.
En el panel Extremos, haga clic en + Extremo
- Ingrese el Nombre del Extremo
- Ingrese el Extremo. Este valor se agrega a la URL del servidor de datos REST.
  - Por ejemplo, si la URL de nuestro servidor de datos REST está configurada en https://api.google.com/rest/v1, un extremo de "análisis" dará como resultado la siguiente URL: https://api.google.com/rest/v1/analytics
Seleccione el Método HTTP para el extremo
Si desea anular el tipo de contenido del extremo Respuesta o Solicitud, haga clic en Más y seleccione Caso extremo
- Desde la sección Tipo de contenido hay dos campos disponibles para esta configuración:
  - Solicitud: el valor seleccionado anulará el tipo de contenido de la solicitud del servidor
  - Respuesta: el valor seleccionado anulará el tipo de contenido de la respuesta del servidor
- El valor predeterminado para Solicitud y Respuesta no está establecido y se heredará del tipo de contenido del servidor. Los valores de Tipo de contenido incluyen Archivo, JSON, Multiparte, Texto sin formato y XML.
Clic en Guardar**
Haga clic en Descubrir para revisar la consultar propuesta y haga clic en Descubrir nuevamente para ejecutar la consultar.
- Esto generará parámetros de entrada para cualquier entrada de muestra ingresada.
- Además, se generarán tablas de salida para cualquier dato que regrese del extremo.
Haga clic en Probar conexión y luego en Continuar para llamar al extremo. Si se definen parámetros de entrada, se enviará su valor de prueba.