Configurar solicitudes REST

www.altova.com Imprimir este apartado Página anterior Subir un nivel Página siguiente

Inicio >  Fuentes de página (orígenes de datos) > Solicitudes HTTP/FTP, REST y SOAP >

Configurar solicitudes REST

La configuración de las solicitudes REST se define en el cuadro de diálogo Solicitud RESTful API (imagen siguiente). Se accede a este cuadro de diálogo en dos situaciones:

 

al definir una fuente de página que use una solicitud REST para conectarse a una fuente de datos
con la acción Ejecutar solicitud REST; en este caso la respuesta a la solicitud se puede almacenar en la variable $MT_HTTPExecute_Result.

 

Puede elegir entre (i) definir su propia configuración, (ii) importar una URL o (ii) usar un archivo WADL. Si elige definir su propia configuración podrá crear sus propias definiciones para cada opción individual. Si importa una URL o usa un archivo WADL, hay opciones que vendrán definidas en la URL o el archivo WADL y que, por tanto, no se pueden personalizar.

mtaddpagesourcedigrestsettings_zoom50

Estas son las diferentes opciones:

 

Plantillas y análisis de resultados, incluyendo $MT_HTTPExecute_Result
Método de solicitud
URL
Autenticación
Parámetros
Contenido HTTP
Campos de encabezado HTTP

 

Plantillas y análisis de resultados

Las plantillas son los tres marcos dentro de los cuales se pueden definir opciones de configuración, sean personalizadas, con URL o con un archivo WADL (imagen siguiente). Puede cambiar de una plantilla a otra en cualquier momento seleccionando el botón de opción correspondiente. Si ya ha seleccionado la plantilla de la URL o la del archivo WADL pero quiere usar una URL o un archivo WADL distintos, entonces haga clic, respectivamente, en Importar desde una URL o Importar desde archivo WADL. Al seleccionar cualquiera de esas dos opciones (o al hacer clic en el botón Importar... que corresponda) se abre un cuadro de diálogo en el que puede especificar la URL o el archivo WADL que quiere usar.

 

 

Definir una configuración propia

Si define una configuración propia puede introducir la solicitud de acceso a un servidor REST en forma de URL, indicar el formato de los datos del recurso de destino (XML, HTML o JSON) y a continuación introducir los datos de autenticación de usuario (y, donde procesa, parámetros de búsqueda) y el contenido y los encabezados HTTP. Consulte a continuación las descripciones de cada una de las opciones.

 

 

Usar una URL

Si una URL es larga o compleja es mejor importarla en la plantilla Usar una URL que introducirla en la plantilla Definir configuración propia. Por ejemplo, una URL puede contener varios parámetros, como en el caso del siguiente ejemplo (una consulta de Google que contiene cinco parámetros):

 

https://www.google.at/search?q=REST+WADL&ie=utf-8&oe=utf-8&gws_rd=cr&ei=89cDVrDHMIP0Up_5vcAB

 

Si importa esta URL, esta se introduce automáticamente en el campo URL de la plantilla y los parámetros pasan automáticamente a la tabla Parámetros de la plantilla. Puede seleccionar el formato de datos del recurso de destino (XML, HTML o JSON) y el Método de solicitud (GET, PUT, POST o DELETE). Ahora puede introducir valores para los parámetros, pero no puede eliminar parámetros ni cambiar su tipo. Si quiere cambiar la URL, haga clic en Importar desde una URL. Para ver las descripciones de los parámetros consulte el apartado Parámetros que se expone a continuación.

 

 

Usar un archivo WADL

Un archivo WADL es un documento XML que define los recursos que ofrece un servicio web y las relaciones entre esos recursos. Los recursos los definen los elementos resource. Cada recurso contiene: (i) elementos param para describir las entradas de un recurso y (ii) elementos method para describir la solicitud y la respuesta de un recurso. El elemento request indica cómo representar la entrada, qué tipos se necesitan y si hay algún encabezado HTTP concreto que sea necesario. El elemento response describe la respuesta del servicio, así como información sobre errores.
 

Al seleccionar la opción WADL, la aplicación le pedirá que indique qué archivo WADL quiere usar. Tras hacer clic en Aceptar aparece el cuadro de diálogo "Elegir método para el recurso" (imagen siguiente). Este cuadro de diálogo muestra los métodos que hay definidos en el archivo WADL.

MTAddPageSourceDIgRestSettingsWADL02

Seleccione el método que prefiera y haga clic en Aceptar. La URL del recurso se introduce en el campo URL de la plantilla, y los parámetros y el contenido y los encabezados HTTP definidos en el archivo WADL para ese recurso pasan a las tablas correspondientes de la plantilla (imagen siguiente). En la plantilla puede introducir los valores de los parámetros y del contenido y los encabezados HTTP, pero no puede eliminar parámetros ni editar sus nombres.

mtaddpagesourcedigrestsettingswadl03_zoom60

 

Analizar resultados como

Los resultados son lo que devuelve el servicio web en respuesta a la solicitud. En las plantillas Configuración propia y URL debe indicar cómo se tienen que analizar estos resultados (como XML, HTML o JSON) para que MobileTogether pueda procesarlos correctamente. En el caso de la plantilla WADL la información sobre el formato de los resultados se toma automáticamente de las definiciones del archivo WADL, por lo que en esta plantilla esos botones de opción están deshabilitados.

 

$MT_HTTPExecute_Result

Puede elegir si el resultado se almacena en $MT_HTTPExecute_Result o no. Si decide almacenarlo aquí puede usar el resultado en otras ubicaciones dentro del diseño mediante esta variable. Observe que esta opción no aparece en el cuadro de diálogo "RESTful API Request" cuando la fuente de página se define por primera vez. Aparece cuando el cuadro de diálogo se abre con la acción Ejecutar solicitud REST.

 

Método de solicitud

En las plantillas Configuración propia y URL se debe indicar el método de la solicitud (GET, PUT, POST o DELETE). En el caso de la plantilla WADL, el método de la solicitud viene determinado por la selección que haga en el cuadro de diálogo "Elija un método para el recurso" (imagen anterior), tras lo cual queda automáticamente seleccionado en la plantilla, en la que, en consecuencia, esos botones de opción quedan deshabilitados.

 

URL

El campo URL solo se puede editar en la plantilla Configuración propia. En ella puede introducir la URL directamente o como expresión XPath. Use el botón Restaurar para borrar la entrada del campo URL.

 

Autenticación

Puede proporcionar información de autenticación si esta es necesaria para acceder al servidor. Si no se requiere autenticación, seleccione la opción Ninguna en el cuadro de diálogo "Solicitud RESTful API" (imagen anterior).

 

Hay tres modos de proporcionar la información de autenticación:

 

Básico: se suministran un nombre de usuario y una contraseña (imagen siguiente)
OAuth 1.0
OAuth 2.0

 

Si quiere configurar la información de autenticación, haga clic en el botón Configurar autenticación, en el cuadro de diálogo "Solicitud RESTful API" (imagen anterior), para abrir el cuadro de diálogo "Configuración de la autenticación" (imagen siguiente), en el que puede seleccionar el tipo de autenticación que requiere el servidor e introducir los detalles de autenticación.

MTAddPageSourceDIgRESTAuthentication

Autenticación de OAuth

OAuth autentica MobileTogether Designer y autoriza el acceso a los recursos del servicio web indicado por la URL (se asume que el servicio web es compatible con OAuth). Para ver un ejemplo de servicio web compatible con OAUTH, consulte el apartado Documentación BitBucket sobre OAuth 1.0.

 

A continuación explicamos a grandes rasgos el funcionamiento del sistema OAuth:

 

1.En el servicio web, cree una clave (o ID) y un secreto OAuth. Estos dos elementos juntos se denominan un consumidor OAuth.
2.Anote los terminales del servicio web. Hay tres puntos de conexión para OAuth 1.0 (Terminal inicial, Terminal de autorización y Terminal token) y dos para OAuth 2.0 (Terminal de autorización y Terminal token). Los terminales suelen mantenerse constantes para todos los consumidores.
3.Configure la aplicación para que acceda al servicio web con estos cinco (OAuth 1.0) y cuatro (OAuth 2.0) elementos de autenticación.

 

Tras haber obtenido su clave y su secreto del servicio web, y una vez anotados los terminales que necesita, ya está preparado para configurar MobileTogether Designer para que acceda al servicio web. Para ello siga estos pasos:

 

1.En el cuadro de diálogo "Configuración de la autenticación" (imagen anterior), haga clic en Configurar OAuth 1.0 o en Configurar OAth 2.0. Aparecerá el cuadro de diálogo "Configuración OAuth" (imagen siguiente).

MTAddPageSourceRESTOAuthSettings

2.Defina la Dirección de devolución de llamada como http://localhost:8083. Esta dirección es invariable; se trata de la dirección del equipo que está utilizando.
3.Crear configuración nueva: debe dar un nombre a su configuración. Esto habilita la opción de reutilizar esa configuración (con la opción del cuadro combinado Volver a utilizar configuración) para otras soluciones que usen los mismos recursos.
4.Introduzca los terminales declarados por el servicio web. Estos suelen ser constantes para todos los consumidores del servicio web.
5.Introduzca su clave (o ID) y su secreto.
6.Para finalizar, haga clic en Autorizar.

 

Parámetros

En la plantilla Definir configuración propia se pueden añadir, editar y eliminar parámetros libremente. Sin embargo, en las plantillas Usar URL y Usar archivo WADL solo puede editar los valores de los parámetros; no puede añadir o eliminar parámetros ni editar sus nombres.

 

Puede añadir los siguientes tipos (o estilos) de parámetros (véase la columna "Estilos" en la imagen de más abajo):

 

Plantilla: los parámetros de la plantilla usan marcadores de posición para sustituir un valor en una URL en tiempo de ejecución. Por ejemplo, en la imagen siguiente observamos que hay un parámetro de plantilla con el marcador de posición {product}, que se usa en la URL y se encuentra entre llaves para indicar que se trata de un marcador de posición. Cuando se usa la URL en tiempo de ejecución, el valor del marcador de posición es sustituido el lugar correspondiente dentro de la URL. La parte relevante de la URL se resolvería por lo tanto en: https://docs.altova.com/XMLSpy.../features.
Matriz: en el caso de parámetros de la matriz, el marcador de posición de la URL es sustituido por el par name=value. En el ejemplo de más abajo existen dos parámetros de matriz que encontramos en la URL como los marcadores de posición {language} y {version}. Estos marcadores, una vez resueltos, corresponderían a las partes resaltadas de esta URL: https://docs.altova.com/XMLSpy;lang=en;ver=2016.../features. El punto y coma ; es un separador que precede a cada parámetro como parte de la sustitución.
Matriz booleana: si el valor de un parámetro de matriz booleana es true, entonces el marcador de posición del parámetro es reemplazado por el nombre del parámetro. Si el valor es false, entonces el marcador de posición es reemplazado por una cadena vacía (es decir, nada). En el ejemplo de más abajo, ese marcador de posición de matriz booleana se resolvería en la parte resaltada de esta URL: https://docs.altova.com/XMLSpy;lang=en;ver=2016;sort/features. El punto y coma ; es un separador que precede a cada parámetro como parte de la sustitución.
Consulta: los parámetros de consulta no usan marcadores de posición. Todos los parámetros de consulta se recogen en una cadena de consulta que se anexa en tiempo de ejecución a la parte de la URL que indica la ruta. Por ejemplo, la URL de la imagen siguiente se resuelve en tiempo de ejecución en: https://docs.altova.com/XMLSpy;lang=en;ver=2016;sort/features?type=PDF. El signo de interrogación ? precede a la cadena de consulta. Si hay otras consultas, el estas llevan como prefijo el símbolo &. Así, una cadena de consulta con dos consultas tendrá este aspecto: ?type=PDF&about=json.

MTDRESTRequestParams

Columnas de la tabla "Parámetros"

La tabla Parámetros contiene cuatro columnas. Hemos explicado el uso de las primeras tres más arriba, en la descripción de los tipos de parámetros. Observe que los parámetros plantilla, matriz y matriz booleana usan marcadores de posición. Mientras que los marcadores de posición de los parámetros de plantilla son reemplazados por valores, los de los parámetros matriz y matriz booleana son reemplazados respectivamente por pares nombre-valor y nombres. Los parámetros de búsqueda no tienen marcadores de posición; sus pares nombre-valor se anexan a la parte de la ruta de la URL. La columna Descripción contiene las descripciones del parámetro para usted, usuario de MobileTogether Designer.

 

 

Iconos de la tabla "Parámetros" y edición de la tabla

En la parte superior derecha de la tabla Parámetros encontrará los iconos que permiten gestionar las entradas de la tabla.

 

Agregar e insertar parámetros: use el icono Agregar parámetro para añadir un parámetro nuevo como último de la tabla. Use el icono Insertar parámetro para añadir un parámetro nuevo justo encima del parámetro que esté seleccionado. El orden en que se añaden los parámetros a la lista no es importante. Sí lo es el orden de los marcadores de posición en la URL. Todos los parámetros de búsqueda se recogen en una cadena de búsqueda que se anexa a la parte de la ruta de la URL en tiempo de ejecución.
Eliminar parámetros: haga clic en Eliminar parámetro para borrar de la lista el parámetro seleccionado.
Expresiones XPath para los valores de los parámetros: cuando seleccione un parámetro, haga clic en XPath para abrir el cuadro de diálogo "Editar expresión XPath/XQuery" e introduzca en él una expresión que se resuelva en una cadena. Esta cadena se usa como valor del parámetro. Si es el caso, en la columna Valor del parámetro aparece un icono XPath. Puede editar la expresión XPath haciendo clic en él.
Restaurar el parámetro: haga clic en Restaurar el parámetro para borrar el valor del parámetro seleccionado.
Editar nombres y valores de parámetros: haga clic en el campo correspondiente para editar esta información.

 

Contenido HTTP

Puede especificar qué contenido enviar con las solicitudes HTTP PUT y POST. Puede enviar ese contenido como un único elemento en el cuerpo de la solicitud (Enviar contenido como cuerpo) o como varios elementos en una solicitud multiparte (Enviar contenidos como multiparte). Seleccione el botón de opción que corresponda a la variante que necesite.

MTDRESTRequestHTTPContent

Use los iconos de la parte superior derecha para agregar o insertar una entrada de contenido.

 

Enviar contenido como cuerpo

Introduzca el valor y el tipo MIME del contenido. El contenido se puede introducir directamente o se puede acceder a él desde un nodo XML.

 

Enviar contenidos como multiparte

Introduzca el nombre de la parte del contenido que se va a enviar, el tipo de acceso al contenido, el contenido mismo y el tipo MIME del contenido. El valor del contenido es el contenido que se envía. En la imagen anterior el contenido se obtiene de nodos de fuente de página con expresiones XPath. Las imágenes se envían cifradas en base 64 o como archivo.

 

Campos de encabezado HTTP

Los campos de cabecera HTTP son pares nombre-valor separados por punto y coma, por ejemplo: Accept:text/plain. Agregue o inserte una entrada por cada cabecera y luego introduzca el nombre y valor de la cabecera (imagen siguiente).

MTDRESTRequestHTTPHeader

 


© 2019 Altova GmbH