json-to-xml

Verwenden Sie die Richtlinie json-to-xml , um die Kontextnutzdaten Ihrer API aus dem JSON-Format ( JavaScript Object Notation) in das XML-Format (Extensible Markup Language) zu konvertieren.

Gateway-Unterstützung

Tabelle 1. Tabelle, in der angegeben wird, welche Gateways diese Richtlinie unterstützen, sowie die entsprechende Richtlinienversion
Gateway	Richtlinienversion
DataPower® Gateway (v5 compatible)	1.0.0
DataPower API Gateway	2.0.0

In diesem Abschnitt wird beschrieben, wie Sie die Richtlinie in Ihrer OpenAPI -Quelle konfigurieren. Details zur Konfiguration der Richtlinie in der Assembly-Benutzerschnittstelle finden Sie unter JSON zu XML.

Produktinfo

Die json-to-xml -Richtlinie hat die folgende Struktur:

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

Hinweis: Bei Verwendung von DataPower API Gatewaymuss die Eingabe für die json-to-xml -Richtlinie geparste Daten sein. Eine Möglichkeit, analysierte Daten zu erzeugen, ist die Verwendung einer parse -Richtlinie vor einer json-to-xml -Richtlinie in Ihrem Assembly-Ablauf, die eine explizite Steuerung der Parsing-Aktion ermöglicht.

Eigenschaften

In der folgenden Tabelle werden die Richtlinieneigenschaften beschrieben:

Tabelle 2. Richtlinieneigenschaften
Eigenschaft	Erforderlich	Beschreibung	Datentyp
version	Ja	Die Versionsnummer der Richtlinie	Zeichenfolge
title	Ja	Der Titel der Richtlinie.	Zeichenfolge
description	Nein	Eine Beschreibung der Richtlinie.	Zeichenfolge
input	Nein	Die zu konvertierende Eingabenachricht. Geben Sie den Namen einer Variablen im API-Kontext an. `variableName.body` Die Nachrichtennutzdaten stellen die zu konvertierende JSON-Eingabe dar. Der Standardwert für die Variable ist `message` und die Standardeingabe ist `message.body`.	Zeichenfolge
output	Nein	Die Ausgabenachricht zum Speichern des Konvertierungsergebnisses. Geben Sie den Namen einer Variablen im API-Kontext an. `variableName.body` stellt das Ergebnis der Konvertierung aus dem JSON-Format in das XML-Format dar. Wenn es sich bei der angegebenen Eingabenachricht um die Standardnachricht handelt, lautet die Standardausgabe `message.body`. Wenn es sich andernfalls bei der Eingabenachricht z. B. um die Variable `my-message-variable` handelt, ist `my-message-variable.body` die Standardausgabe. Die Variable kann im API-Kontext nicht schreibgeschützt sein.	Zeichenfolge
conversionType	Nein	Der Konvertierungstyp, der das Zielformat der Ausgabe bestimmt. Die folgenden Optionen sind verfügbar: Keine Angabe: Es findet keine Konvertierung der Ausgabe statt. BadgerFish: Es wird die BadgerFish-Konvention verwendet, um das Zielkonvertierungsformat der Ausgabe zu bestimmen.	Zeichenfolge
root-element-name	Ja	Der Stammelementname des XML-Dokuments. Diese Eigenschaft wird nur verwendet, wenn das Eingabe-JSON-Dokument nicht hierarchisch ist und über mehrere Eigenschaften auf höchster Ebene verfügt oder wenn die Eigenschaft always-output-root-element auf `true` gesetzt ist.
always-output-root-element	Ja	Wählen Sie für diese Eigenschaft immer `true` aus, wenn Sie möchten, dass die Richtlinie immer das Stammelement ausgibt, selbst wenn es nicht erforderlich ist, um das XML-Dokument gut zu formatieren.	Boolesch
unnamed-element-name	Nein	Der für JSON-Arrayelemente zu verwendende XML-Elementname.	Zeichenfolge

Beispiel

Das folgende Beispiel zeigt eine json-to-xml-Richtlinie:

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