Política XMLtoJSON

Estás viendo la documentación de Apigee Edge.
Ve a la Documentación de Apigee X. información

Qué

Esta política convierte mensajes del formato de lenguaje de marcación extensible (XML) a la notación de objetos de JavaScript (JSON), lo que te brinda varias opciones para controlar cómo se convierten los mensajes.

Si se desea convertir una respuesta con formato XML en una respuesta con formato JSON, la política se debe adjuntar a un flujo de respuesta (por ejemplo, Response/ProxyEndpoint/PostFlow).

Información

En una situación de mediación típica, una política de JSON a XML en el flujo de solicitud entrante se suele vincular con una política de XML a JSON en el flujo de respuesta saliente. Cuando se combinan políticas de esta manera, se puede exponer una API de JSON para servicios de backend que solo admiten XML de forma nativa.

En situaciones en que las diversas apps cliente que consumen las API pueden requerir JSON o XML, el formato de respuesta se puede configurar de forma dinámica mediante la configuración de políticas de JSON a XML y de XML a JSON para ejecutarlas de manera condicional. Consulta Variables y condiciones de flujo para ver una implementación de esta situación.

Muestras

Para ver un análisis detallado sobre la conversión entre JSON y XML, consulta http://community.apigee.com/articles/1839/converting-between-xml-and-json-what-you-need-to-k.html.

<XMLToJSON name="ConvertToJSON">
  <Options>
  </Options>
  <OutputVariable>response</OutputVariable>
  <Source>response</Source>
</XMLToJSON>

Referencia del elemento

A continuación, se describen los elementos y los atributos que puedes configurar en esta política.

<XMLToJSON async="false" continueOnError="false" enabled="true" name="XML-to-JSON-1">
    <DisplayName>XML to JSON 1</DisplayName>
    <Source>response</Source>
    <OutputVariable>response</OutputVariable>
    <Options>
        <RecognizeNumber>true</RecognizeNumber>
        <RecognizeBoolean>true</RecognizeBoolean>
        <RecognizeNull>true</RecognizeNull>
        <NullValue>NULL</NullValue>
        <NamespaceBlockName>#namespaces</NamespaceBlockName>
        <DefaultNamespaceNodeName>&</DefaultNamespaceNodeName>
        <NamespaceSeparator>***</NamespaceSeparator>
        <TextAlwaysAsProperty>true</TextAlwaysAsProperty>
        <TextNodeName>TEXT</TextNodeName>
        <AttributeBlockName>FOO_BLOCK</AttributeBlockName>
        <AttributePrefix>BAR_</AttributePrefix>
        <OutputPrefix>PREFIX_</OutputPrefix>
        <OutputSuffix>_SUFFIX</OutputSuffix>
        <StripLevels>2</StripLevels>
        <TreatAsArray>
            <Path unwrap="true">teachers/teacher/studentnames/name</Path>
        </TreatAsArray>
    </Options>
    <!-- Use Options or Format, not both -->
    <Format>yahoo</Format>
</XMLToJSON>

Atributos <XMLtoJSON>

<XMLtoJSON async="false" continueOnError="false" enabled="true" name="XML-to-JSON-1"> 

En la siguiente tabla, se describen los atributos que son comunes a todos los elementos principales de las políticas:

Elemento <DisplayName>

Se usan además del atributo name para etiquetar la política en el editor de proxy de la IU de administración con un nombre de lenguaje natural diferente.

<DisplayName>Policy Display Name</DisplayName>

Elemento <Source>

La variable, la solicitud o la respuesta, que contiene el mensaje XML que quieres convertir en JSON.

El encabezado de tipo de contenido HTTP del mensaje fuente debe establecerse como application/xml; de lo contrario, la política no se aplica.

Si <Source> no está definido, se trata como un mensaje (que se resuelve como solicitud cuando la política se adjunta a un flujo de solicitud, o como respuesta cuando la política se adjunta a un flujo de respuesta).

Si la variable de origen no se puede resolver o se resuelve en un tipo que no es de mensaje, la política muestra un error.

<Source>response</Source>

Elemento <OutputVariable>

Almacena el resultado de la conversión de formato XML a JSON. Por lo general, es el mismo valor que el origen, es decir, la respuesta XML suele convertirse en una respuesta JSON.

La carga útil del mensaje XML se analiza y se convierte en JSON, y el encabezado de tipo de contenido HTTP del mensaje con formato XML se establece en application/json.

Si no se especifica OutputVariable, source se trata como OutputVariable. Por ejemplo, si el source es response, entonces OutputVariable se configura de forma predeterminada como response.

<OutputVariable>response</OutputVariable>

<Options>

Las opciones te permiten controlar la conversión de XML a JSON. Usa el grupo <Options>, que te permite agregar una configuración de conversión específica, o el elemento <Format>, que te permite hacer referencia a una plantilla de opciones predefinidas. No puedes usar <Options> y <Format> al mismo tiempo.

El elemento <Options> es obligatorio si no se usa <Format>.

Elemento <Options>/<RecognizeNumber>

Si es verdadero, los campos de número en la carga útil de XML conservan su formato original.

<RecognizeNumber>true</RecognizeNumber>

Considera el siguiente ejemplo de XML:

<a>
  <b>100</b>
  <c>value</c>
</a>

Si es true, se convierte en lo siguiente:

{
    "a": {
        "b": 100,
        "c": "value"
    }
}

Si es false, se convierte en lo siguiente:

{
    "a": {
        "b": "100",
        "c": "value"
    }
}

Elemento <Options>/<RecognizeBoolean>

Permite que la conversión mantenga valores booleanos verdaderos o falsos en lugar de convertir los valores en strings.

<RecognizeBoolean>true</RecognizeBoolean>

Observa este ejemplo de XML:

<a>
  <b>true</b>
  <c>value</c>
</a>

Si es true, se convierte en lo siguiente:

{
    "a": {
        "b": true,
        "c": "value"
    }
}

Si es false, se convierte en lo siguiente:

{
    "a": {
        "b": "true",
        "c": "value"
    }
}

Elemento <Options>/<RecognizeNull>

Te permite convertir valores vacíos en valores nulos.

<RecognizeNull>true</RecognizeNull>

Observa el siguiente XML:

<a>
  <b></b>
  <c>value</c>
</a>

Si es true, se convierte en lo siguiente:

{
  "a": {
    "b": null,
    "c": "value"
  }
}

Si es false, se convierte en lo siguiente:

{
  "a": {
    "b": {},
    "c": "value"
  }
}

Elemento <Options>/<NullValue>

Indica el valor al que se deben convertir los valores nulos reconocidos en el mensaje de origen. El valor predeterminado es null. Esta opción solo es efectiva si RecognizeNull es verdadero.

<NullValue>not-present</NullValue>

<Options>/<NamespaceBlockName>
<Options>/<DefaultNamespaceNodeName>
<Options>/<NamespaceSeparator> elements

Usa estos elementos en conjunto.

<NamespaceBlockName>#namespaces</NamespaceBlockName>
<DefaultNamespaceNodeName>&</DefaultNamespaceNodeName>
<NamespaceSeparator>***</NamespaceSeparator>

Considera el siguiente ejemplo de XML:

<a xmlns="http://ns.com" xmlns:ns1="http://ns1.com">
  <ns1:b>value</ns1:b>
</a>

Si no se especifica NamespaceSeparator, se genera la siguiente estructura JSON:

{
    "a": {
        "b": "value"
    }
}

Si los elementos NamespaceBlockName, DefaultNamespaceNodeName y NamespaceSeparator se especifican como #namespaces, & y ***, respectivamente, entonces se genera la siguiente estructura JSON:

{
    "a": {
        "#namespaces": {
            "&": "http://ns.com",
            "ns1": "http://ns1.com"
        },
        "ns1***b": "value"
    }
}

Elementos <Options>/<TextAlwaysAsProperty>
y <Options>/<TextNodeName>

Usa estos elementos en conjunto.

Si se configura como true, el contenido del elemento XML se convierte en una propiedad de string.

<TextAlwaysAsProperty>true</TextAlwaysAsProperty>
<TextNodeName>TEXT</TextNodeName>

Observa el siguiente XML:

<a>
  <b>value1</b>
  <c>value2<d>value3</d>value4</c>
</a>

Si TextAlwaysAsProperty se configura como true, y TextNodeName se especifica como TEXT, se genera la siguiente estructura JSON:

{
  "a": {
    "b": {
      "TEXT": "value1"
    },
    "c": {
      "TEXT": [
        "value2",
        "value4"
        ],
        "d": {
          "TEXT": "value3"
        }
      }
    }
}

Si TextAlwaysAsProperty se configura como false, y TextNodeName se especifica como TEXT, se genera la siguiente estructura JSON:

{
  "a": {
    "b": "value1",
    "c": {
      "TEXT": [
        "value2",
        "value4"
      ],
      {
        "d": "value3",
      }
    }
}

Elementos <Options>/<AttributeBlockName>
y <Options>/<AttributePrefix>

Usa estos elementos en conjunto.

Te permite agrupar valores en un bloque JSON y agregar prefijos a los nombres de atributos.

<AttributeBlockName>FOO_BLOCK</AttributeBlockName>
<AttributePrefix>BAR_</AttributePrefix>

Considera el siguiente ejemplo de XML:

<a attrib1="value1" attrib2="value2"/>

Si los atributos (AttributeBlockName y AttributePrefix) se especifican como se define en el ejemplo de XML a JSON, se genera la siguiente estructura JSON:

{
  "a": {
    "FOO_BLOCK": {
      "BAR_attrib1": "value1",
      "BAR_attrib2": "value2"
    }
  }
}

Si solo se especifica AttributeBlockName, se genera la siguiente estructura JSON:

{
    "a": {
        "FOO_BLOCK": {
            "attrib1": "value1",
            "attrib2": "value2"
        }
    }
}

Si solo se especifica AttributePrefix, se genera la siguiente estructura JSON:

{
    "a": {
        "BAR_attrib1": "value1",
        "BAR_attrib2": "value2"
    }
}

Si no se especifica ninguna, se genera la siguiente estructura JSON:

{
    "a": {
        "attrib1": "value1",
        "attrib2": "value2"
    }
}

Elementos <Options>/<OutputPrefix>
y <Options>/<OutputSuffix>

Usa estos elementos en conjunto.

<OutputPrefix>PREFIX_</OutputPrefix>
<OutputSuffix>_SUFFIX</OutputSuffix>

Considera el siguiente ejemplo de XML:

<a>value</a>

Si los atributos (OutputPrefix y OutputSuffix) se especifican como se define en el ejemplo de XML a JSON, se genera la siguiente estructura JSON:

PREFIX_{
    "a": "value"
}_SUFFIX

Si solo se especifica OutputPrefix, se genera la siguiente estructura JSON:

PREFIX_{
  "a" : "value"
}

Si solo se especifica OutputSuffix, se genera la siguiente estructura JSON:

{
  "a" : "value"
}_SUFFIX

Si no se especifican OutputPrefix ni OutputSuffix, se genera la siguiente estructura JSON:

{
    "a": "value"
}

Elemento <Options>/<StripLevels>

<Options>
    <StripLevels>4</StripLevels>
</Options>

A veces, las cargas útiles XML, como SOAP, tienen muchos niveles superiores que no quieres incluir en el JSON convertido. A continuación, se muestra un ejemplo de una respuesta de SOAP que contiene muchos niveles:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/Schemata-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
      <GetCityWeatherByZIPResponse xmlns="http://ws.cdyne.com/WeatherWS/">
          <GetCityWeatherByZIPResult>
              <State>CO</State>
              <City>Denver</City>
              <Description>Sunny</Description>
              <Temperature>62</Temperature>
          </GetCityWeatherByZIPResult>
      </GetCityWeatherByZIPResponse>
  </soap:Body>
</soap:Envelope>

Hay 4 niveles antes de llegar al nivel de estado, ciudad, descripción y temperatura. Sin usar <StripLevels>, la respuesta JSON convertida se vería de la siguiente manera:

{
   "Envelope" : {
      "Body" : {
         "GetCityWeatherByZIPResponse" : {
            "GetCityWeatherByZIPResult" : {
               "State" : "CO",
               "City" : "Denver",
               "Description" : "Sunny",
               "Temperature" : "62"
            }
         }
      }
   }
}

Si deseas quitar esos primeros 4 niveles de la respuesta JSON, debes establecer <StripLevels>4</StripLevels>, lo que generará el siguiente JSON:

{
  "State" : "CO",
  "City" : "Denver",
  "Description" : "Sunny",
  "Temperature" : "62"
}

Puedes quitar niveles hasta el primer elemento que contiene varios elementos secundarios. ¿Qué significa eso? Veamos un ejemplo de JSON más complejo:

{
   "Envelope" : {
      "Body" : {
         "GetCityForecastByZIPResponse" : {
            "GetCityForecastByZIPResult" : {
               "ResponseText" : "City Found",
               "ForecastResult" : {
                  "Forecast" : [
                     {
                        "ProbabilityOfPrecipiation" : {
                           "Nighttime" : "00",
                           "Daytime" : 10
                        }  ...

En el ejemplo, el nivel 3 es GetCityForecastByZIPResponse, que solo tiene un elemento secundario. Entonces, si usaras <StripLevels>3</StripLevels> (se deben quitar los primeros tres niveles), el JSON se vería así:

{
   "GetCityForecastByZIPResult" : {
      "ResponseText" : "City Found",
      "ForecastResult" : {
         "Forecast" : [
            {
               "ProbabilityOfPrecipiation" : {
                  "Nighttime" : "00",
                  "Daytime" : 10
               }  ...

Ten en cuenta que GetCityForecastByZIPResult tiene varios elementos secundarios. Como es el primer elemento que contiene varios elementos secundarios, puedes quitar este último nivel con <StripLevels>4</StripLevels>, lo que generará el siguiente JSON:

{
   "ResponseText" : "City Found",
   "ForecastResult" : {
      "Forecast" : [
         {
            "ProbabilityOfPrecipiation" : {
               "Nighttime" : "00",
               "Daytime" : 10
            }  ...

Debido a que el nivel 4 es el primer nivel que contiene varios elementos secundarios, no puedes anular los niveles inferiores a él. Si configuras el nivel de banda en 5, 6, 7, etc., seguirás recibiendo la respuesta anterior.

Elemento <Options>/<TreatAsArray>/<Path>

<Options>
    <TreatAsArray>
        <Path unwrap="true">teachers/teacher/studentnames/name</Path>
    </TreatAsArray>
</Options>

Esta combinación de elementos te permite asegurarte de que los valores de un documento XML se coloquen en un array de JSON. Esto es útil, por ejemplo, cuando la cantidad de elementos secundarios puede variar (de uno a varios) y quieres asegurarte de que los valores estén siempre en un array. Esto ayuda a mantener tu código estable, ya que puedes obtener datos del array de la misma manera cada vez. Por ejemplo: $.teachers.teacher.studentnames[0] obtiene el primer valor de nombre de estudiante en el array, sin importar la cantidad de valores en el array.

Observemos el comportamiento predeterminado de la conversión XML a JSON y, luego, exploremos cómo controlar el resultado mediante <TreatAsArray>/<Path>.

Cuando un documento XML contiene un elemento con varios valores secundarios (por lo general, basado en un esquema en el que el maxOccurs='unbounded' del elemento), la política de XML a JSON coloca automáticamente esos valores en un array. Por ejemplo, el siguiente bloque XML

<teacher>
    <name>teacherA</name>
    <studentnames>
        <name>student1</name>
        <name>student2</name>
    </studentnames>
</teacher>

se convierte al siguiente JSON de forma automática sin una configuración de política especial:

{
  "teachers" : {
      "teacher" : {
          "name" : "teacherA",
          "studentnames" : {
              "name" : [
                 "student1",
                 "student2"
              ]}
           }
      }
}

Observa que los dos nombres de los alumnos se colocan en un arreglo.

Sin embargo, si solo aparece un alumno en el documento XML, la política de XML a JSON trata automáticamente el valor como una sola string, no como un arreglo de strings, como se muestra en el siguiente ejemplo:

{
  "teachers" : {
      "teacher" : {
          "name" : "teacherA",
          "studentnames" : {
              "name" : "student1"
              }
          }
      }
}

En los ejemplos anteriores, los datos similares se convirtieron de otra manera; una vez como un array, otra como una sola string. Aquí es donde el elemento <TreatAsArray>/<Path> te permite controlar el resultado. Por ejemplo, puedes asegurarte de que los nombres de los alumnos siempre se coloquen en un array, aunque solo haya un valor. Para configurar esto, identifica la ruta de acceso al elemento cuyos valores deseas incluir en un array, de la siguiente manera:

<Options>
    <TreatAsArray>
        <Path>teachers/teacher/studentnames/name</Path>
    </TreatAsArray>
</Options>

Con la configuración anterior, el JSON se escribiría de esta manera:

{
  "teachers" : {
      "teacher" : {
          "name" : "teacherA",
          "studentnames" : {
              "name" : ["student1"]
              }
            ]
          }
      }
}

Observa que student1 ahora está en un array. Ahora, independientemente de si hay uno o varios estudiantes, puedes recuperarlos desde un array de JSON en tu código con la siguiente ruta JSON: $.teachers.teacher.studentnames.name[0]

El elemento <Path> también tiene un atributo unwrap, que se explica en la siguiente sección.

Atributos

 <Options>
    <TreatAsArray>
        <Path unwrap="true">teachers/teacher/studentnames/name</Path>
    </TreatAsArray>
</Options>

{
  "teachers" : {
      "teacher" : {
          "name" : "teacherA",
          "studentnames" : {
              "name" : [
                 "student1",
                 "student2"
              ]}...

<TreatAsArray>
    <Path unwrap="true">teachers/teacher</Path>
    <Path unwrap="true">teachers/teacher/studentnames/name</Path>
</TreatAsArray>

{
  "teachers" : [{
      "name" : "teacherA",
      "studentnames" : ["student1","student2"]
      }]...

Para obtener más ejemplos y una explicación de las funciones, consulte este artículo de la comunidad de Apigee: https://community.apigee.com/content/kbentry/33374/new-edge-minifeature-the-treatasarray-option-in-th.html.

<Format>

El formato te permite controlar la conversión de XML a JSON. Ingresa el nombre de una plantilla predefinida que contiene una combinación específica de elementos de opciones que se describen en este tema. Los formatos predefinidos incluyen los siguientes: xml.com, yahoo, google y badgerFish.

Usa el elemento <Format> o el grupo <Options>. No puedes usar <Format> y <Options> al mismo tiempo.

A continuación, se presentan las definiciones de Format de cada plantilla predefinida.

xml.com

<RecognizeNull>true</RecognizeNull>
<TextNodeName>#text</TextNodeName>
<AttributePrefix>@</AttributePrefix>

yahoo

<RecognizeNumber>true</RecognizeNumber>
<TextNodeName>content</TextNodeName>

google

<TextNodeName>$t</TextNodeName>
<NamespaceSeparator>$</NamespaceSeparator>
<TextAlwaysAsProperty>true</TextAlwaysAsProperty>

badgerFish

<TextNodeName>$</TextNodeName>
<TextAlwaysAsProperty>true</TextAlwaysAsProperty>
<AttributePrefix>@</AttributePrefix>
<NamespaceSeparator>:</NamespaceSeparator>
<NamespaceBlockName>@xmlns</NamespaceBlockName>
<DefaultNamespaceNodeName>$</DefaultNamespaceNodeName>

Sintaxis del elemento:

<Format>yahoo</Format>

Esquemas

Referencia de errores

This section describes the fault codes and error messages that are returned and fault variables that are set by Edge when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults.

Runtime errors

These errors can occur when the policy executes.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Fault variables

These variables are set when a runtime error occurs. For more information, see What you need to know about policy errors.

Example error response

{
  "fault": {
    "faultstring": "XMLToJSON[XMLtoJSON-1]: Source xyz is not available",
    "detail": {
      "errorcode": "steps.xml2json.SourceUnavailable"
    }
  }
}

Example fault rule

<faultrule name="VariableOfNonMsgType"></faultrule><FaultRule name="XML to JSON Faults">
    <Step>
        <Name>AM-SourceUnavailableMessage</Name>
        <Condition>(fault.name Matches "SourceUnavailable") </Condition>
    </Step>
    <Step>
        <Name>AM-BadXML</Name>
        <Condition>(fault.name = "ExecutionFailed")</Condition>
    </Step>
    <Condition>(xmltojson.XMLtoJSON-1.failed = true) </Condition>
</FaultRule>

Temas relacionados

De JSON a XML: política de JSON a XML