json-to-xml

Utilice la política json-to-xml para convertir la carga útil de contexto de la API del formato JSON ( JavaScript Object Notation) al formato XML (Extensible Markup Language).

Soporte de pasarela

Tabla 1. Tabla que muestra qué pasarelas soportan esta política y la versión de política correspondiente
Pasarela Versión de política
DataPower® Gateway (v5 compatible) 1.0.0
DataPower API Gateway 2.0.0

En este tema se describe cómo configurar la política en el origen de OpenAPI ; para obtener detalles sobre cómo configurar la política en la interfaz de usuario de ensamblaje, consulte JSON a XML.

Acerca de

La política json-to-xml tiene la estructura siguiente:
- json-to-xml:
   version: version
   title: Title
   description: Description
Nota: Si utiliza DataPower API Gateway, la entrada de la política json-to-xml deben ser datos analizados. Una forma de generar datos analizados es utilizar una política parse antes que una política json-to-xml en el flujo de ensamblaje, que proporciona un control explícito de la acción de análisis.

Propiedades

La tabla siguiente describe las propiedades de política.
Tabla 2. Propiedades de política
Propiedad Obligatorio Descripción Tipo de datos
version El número de versión de la política serie
title El título de la política. serie
description Nee Una descripción de la política. serie
DataPower API Gateway
onlyinput Nee El mensaje de entrada que se debe convertir. Especifique el nombre de una variable en el contexto de la API. variableName.body la carga útil del mensaje, representa la entrada JSON que se va a convertir. El valor predeterminado de la variable es message y message.body es la entrada predeterminada. serie
DataPower API Gateway
onlyoutput Nee El mensaje de salida en el que almacenar el resultado de la conversión. Especifique el nombre de una variable en el contexto de la API. variableName.body representa el resultado de la conversión del formato JSON al formato XML. Cuando el mensaje de entrada especificado es el mensaje predeterminado, la salida predeterminada es message.body. De lo contrario, cuando el mensaje de entrada es por ejemplo la variable my-message-variable, la salida predeterminada es my-message-variable.body.

La variable no puede ser de solo lectura en el contexto de la API.

serie
DataPower API Gateway
onlyconversionType Nee El tipo de conversión que determina el formato de destino de la salida. Están disponibles las opciones siguientes:
  • Ninguno: no tiene lugar ninguna conversión de la salida.
  • badgerFish: se utiliza el convenio de BadgerFish para determinar el formato de conversión de destino de la salida.
serie
root-element-name El nombre del elemento raíz del documento XML resultante. Esta propiedad solo se utiliza si el documento JSON de entrada no es jerárquico y tiene más de una propiedad de nivel superior, o si la propiedad always-output-root-element se ha establecido en true.  
always-output-root-element Seleccione esta propiedad como true si desea que la política saque siempre el elemento raíz, incluso aunque no sea necesario que el documento XML tenga un formato adecuado. booleano
unnamed-element-name Nee El nombre de elemento XML que se utilizará para elementos de matriz JSON. serie

Ejemplo

A continuación se proporciona un ejemplo de una política json-to-xml:
- json-to-xml:
   version: 1.0.0
   title: JSON to XML transform
   description: Transforms JSON message body to XML format