json-to-xml

Utilisez la stratégie json-to-xml pour convertir le contenu contextuel de votre API du format JavaScript Object Notation (JSON) au format XML (extensible markup language).

Prise en charge des passerelles

Tableau 1. Tableau des passerelles prenant en charge cette stratégie, ainsi que la version de stratégie correspondante
Passerelle	Version de la stratégie
DataPower® Gateway (v5 compatible)	1.0.0
DataPower API Gateway	2.0.0

Cette rubrique décrit comment configurer la stratégie dans votre source OpenAPI . Pour plus de détails sur la configuration de la stratégie dans l'interface utilisateur de l'assemblage, voir JSON en XML.

A propos de

La stratégie json-to-xml possède la structure suivante:

- json-to-xml:
   version: version
   title: Title
   description: Description

Remarque: Si vous utilisez DataPower API Gateway, l'entrée de la règle json-to-xml doit être des données analysées. Une façon de produire des données analysées consiste à utiliser une stratégie parse avant une stratégie json-to-xml dans votre flux d'assemblage, qui fournit un contrôle explicite de l'action d'analyse.

Propriétés

Le tableau suivant décrit les propriétés de la stratégie :

Tableau 2. Propriétés de politique
Propriété	Obligatoire	Descriptif	Type de données
version	Oui	Numéro de version de la stratégie	chaîne
title	Oui	Titre de la stratégie.	chaîne
description	Non	Description de la stratégie.	chaîne
input	Non	Le message d'entrée à convertir. Indiquez le nom d'une variable dans le contexte d'API. `variableName.body`, le contenu du message représente l'entrée JSON à convertir. La valeur par défaut de la variable est `message` et `message.body` est l'entrée par défaut.	chaîne
output	Non	Le message de sortie pour stocker le résultat de la conversion. Indiquez le nom d'une variable dans le contexte d'API. `variableName.body` représente le résultat de la conversion du format JSON au format XML. Lorsque le message d'entrée indiqué est le message par défaut, la sortie par défaut est `message.body`. Sinon, quand le message d'entrée est la variable `my-message-variable`, par exemple, la sortie par défaut est `my-message-variable.body`. La variable ne peut pas être en lecture seule dans le contexte d'API.	chaîne
conversionType	Non	Type de conversion qui détermine le format cible de la sortie. Les options suivantes sont disponibles : Aucun : Aucune conversion de la sortie n'a lieu. badgerFish : La convention BadgerFish est utilisée pour déterminer le format de conversion de la sortie.	chaîne
root-element-name	Oui	Nom de l'élément racine du document XML résultant. Cette propriété est utilisée uniquement si le document d'entrée JSON n'est pas hiérarchique et possède plusieurs propriétés de niveau supérieur, ou si la propriété always-output-root-element est définie sur `true`.
always-output-root-element	Oui	Définissez cette propriété sur `true` si vous souhaitez que la stratégie génère toujours l'élément racine, même s'il n'est pas requis par la syntaxe du document XML.	booléen
unnamed-element-name	Non	Nom d'élément XML à utiliser pour les éléments de tableau JSON.	chaîne

Exemple

Voici un exemple de stratégie json-to-xml :

- json-to-xml:
   version: 1.0.0
   title: JSON to XML transform
   description: Transforms JSON message body to XML format