Nur DataPower-API-Gateway

Richtlinie JSON to XML für DataPower API Gateway konfigurieren

Führen Sie die folgenden Schritte aus, um die Richtlinie JSON to XML für DataPower® API Gateway in der Assembly-Benutzerschnittstelle zu konfigurieren.

Informationen zu dieser Task

Hinweis In diesem Abschnitt wird die Implementierung der Richtlinie JSON to XML in DataPower API Gatewaybeschrieben. Wenn Sie DataPower Gateway (v5 compatible)verwenden, lesen Sie den Abschnitt JSON-zu-XML-Richtlinie für DataPower Gateway (v5 kompatibel). Weitere Informationen zu den verschiedenen Gateway-Typen finden Sie unter API Connect -Gateway-Typen.

Informationen zum Konfigurieren der Richtlinie in Ihrer OpenAPI -Quelle finden Sie unter json-to-xml.

Vorgehensweise

  1. Klicken Sie im Navigationsfenster auf Symbol 'Entwickeln' im Navigationsfenster Entwickelnund wählen Sie dann die Registerkarte APIsaus.
    Die Seite Entwickeln wird angezeigt.
  2. Klicken Sie auf den Titel der API-Definition, mit der Sie arbeiten wollen, oder erstellen Sie eine neue API.
  3. Wählen Sie die Registerkarte Gateway aus und klicken Sie dann im Navigationsfenster auf Richtlinien .
    Weitere Informationen zum Arbeiten mit dem Assembly-Editor für eine API finden Sie unter Assembly-Editor.
  4. Suchen Sie die Richtlinie JSON to XML in der Palette und ziehen Sie die Richtlinie in Ihren Erstellungsbereich.
  5. Geben Sie die folgenden Eigenschaften an.
    Tabelle 1. Richtlinieneigenschaften
    Eigenschaftsbezeichnung Erforderlich Beschreibung Datentyp
    Titel Ja Der Titel der Richtlinie.

    Der Standardwert ist json-to-xml.

    Zeichenfolge
    Beschreibung Nein Eine Beschreibung der Richtlinie. Zeichenfolge
    Eingabe 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
    Ausgabe 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
    Konvertierungstyp Nein Der Konvertierungstyp, der das Zielformat der Ausgabe bestimmt. Folgende Optionen stehen zur Verfügung:
    • Keine Angabe: Es findet keine Konvertierung der Ausgabe statt.
    • BadgerFish: Es wird die BadgerFish-Konvention verwendet, um das Zielkonvertierungsformat der Ausgabe zu bestimmen.
    Zeichenfolge
    Stamm-XML-Elementname Ja Der Stammelementname des XML-Dokuments. Diese Eigenschaft wird nur verwendet, wenn das JSON-Eingabedokument nicht hierarchisch ist und mehr als eine Eigenschaft der obersten Ebene hat oder wenn das Kontrollkästchen Stammelement immer ausgeben ausgewählt ist.

    Der Standardwert ist json.

    Zeichenfolge
    Stammelement immer ausgeben Ja Wählen Sie dieses Kontrollkästchen aus, wenn die Richtlinie immer das Stammelement ausgeben soll, auch wenn es nicht erforderlich ist, das XML-Dokument korrekt formatiert zu machen.

    Der Standardwert ist false.

    boolesch
    Elementname für JSON-Arrayelemente Nein Der für JSON-Arrayelemente zu verwendende XML-Elementname. Zeichenfolge
  6. Geben Sie eine Version für die Richtlinie an, indem Sie auf das Symbol Quelle Symbol für OpenAPI -Quelleklicken und den Abschnitt version der YAML-Richtliniendatei ausfüllen. Beispiel:
    execute:
      - json-to-xml:
          version: 2.0.0
          title: json-to-xml
      ...
    Sie müssen eine Version für die Richtlinie angeben, die mit dem Gateway kompatibel ist, das Sie verwenden. Wenn die API veröffentlicht wird und die Version nicht mit dem Gateway kompatibel ist, wird ein Gültigkeitsfehler ausgelöst, der die verfügbaren Versionen angibt.
  7. Klicken Sie auf Speichern.

Beispiel

Beispiel: Das folgende einfache JSON-Objekt
{ "a": { "$" : "hello" } }
zur Laufzeit zu
<a>hello</a>
Das folgende JSON-Objekt mit einem Attribut
{ "a": { "$" : "hello", "@type" : "world" } }
zur Laufzeit zu
<a type="world">hello</a>