Primeros pasos y configuración

Utiliza la función de integración de la API REST, que está habilitada de forma predeterminada para el Service Definition Framework.

Funcionalidades compatibles

La integración de la API REST admite los siguientes métodos y formatos de carga útil de HTTP.

Métodos compatibles con « HTTP »

  • GET
  • POST
  • PUT
  • SUPRIMIR
  • PATCH

Formatos de carga útil compatibles

  • JSON
  • XML
IMPORTANTE:

Configuración de compatibilidad con JSON

Para utilizar entradas y salidas JSON en los flujos de servicio, debes configurar una de las siguientes opciones:

Opción 1 : Añadir el servicio a la propiedad «wrap» del JSON:

yfs.xmljson.wrapjson.forflows=YourServiceName,AnotherService

Opción 2 : Configurar el servicio como una herramienta MCP. JSON es el formato predeterminado en MCP Tools.

Solo el componente API, « Kafka » y el emisor/receptor JMS admiten JSON en los flujos de servicio.

Configuración básica

Puedes resolver dinámicamente los siguientes elementos de configuración:

  • Cabeceras
  • Parámetros de consulta
  • URL segmentos
  • OAuth configuración como el ID de cliente, el secreto de cliente y OAuth URL

utilizando:

  • Propiedades del sistema: compatibles con todos los campos, incluidos los de « OAuth »
  • XML XPath: para encabezados, parámetros y URL
  • JSONPath: para encabezados, parámetros y URL
  • Contexto de la solicitud entrante: encabezados y parámetros de consulta
Nota: Los campos de configuración de OAuth, como el ID de cliente, el secreto y URL, se pueden resolver utilizando ${property} la sintaxis.

Elementos de configuración

Tabla 1. Elementos de configuración de la API REST
Elemento Finalidad
URL Punto final REST
Método Método HTTP
Cabeceras Cabeceras de solicitud personalizadas
Parámetros Parámetros de consulta
Autenticación OAuth / Ninguna (menú desplegable)
tiempo de espera Tiempo de espera de la API: opcional