Saltar al contenido

Fuente de Datos REST

Descripción General

La fuente de datos REST ofrece a los desarrolladores la posibilidad de conectarse App Builder a varios servidores REST, incluidas otras instancias de App Builder la configuración de una fuente de datos REST implica tres pasos básicos:

  1. Creación y configuración del servidor de origen de datos REST
  2. Creación de extremos REST para cada método API que llamará
  3. Para las APIs de estilo REST CRUD, crear opcionalmente 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
  • Introduzca un Nombre de servidor
  • Seleccione el tipo REST API en Servicios web

  • Introduzca 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

  • Introduzca el tipo de contenido de la solicitud y la respuesta. Normalmente, los servidores REST se comunican mediante JSON.

  • Ingrese a 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 ingreses una clave API mediante el encabezado de solicitud. Configura el encabezado de 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
    • Agrega el Nombre del parámetro del encabezado
      • Por ejemplo, para App Builder en los servidores REST la clave API se pasa usando "X-API-Key"
  • Agregue el Valor del parámetro de encabezado
  • Haga clic en el icono de marca de verificación para guardar

Configurar Parámetros de Cadena de Consultar

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
    • Agrega el Nombre del parámetro de la cadena de consultar
    • Agrega el Valor del parámetro de la 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 adjunta 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 "analytics" 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 Respuesta o Solicitud del extremo, 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.
  • Haga 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.

Recursos