XML-API in JSON umwandeln: Attribute und Arrays richtig lösen

VeröffentlichtToolJSON ↔ XML Konverter

Inhalt
  1. Warum antworten manche APIs noch immer mit XML?
  2. XML in JSON umwandeln: zuerst Attribute und wiederholte Tags klären
  3. Typische Stolpersteine
  4. Fazit
  5. Häufig gestellte Fragen

Sie öffnen die API-Dokumentation eines Open-Data-Portals oder eines älteren internen Systems, und das Antwortbeispiel ist kein JSON, sondern XML. Das kann durchaus irritieren. Neue APIs setzen heute fast durchweg auf JSON, daher ist schwer nachvollziehbar, warum manche Systeme an XML festhalten. Dieser Artikel erklärt die Gründe und zeigt, wie Sie empfangenes XML in das leichter zu verarbeitende JSON umwandeln.

Zusammenfassung ① Behörden und ältere Systeme verwenden XML, weil sie noch die Architektur nutzen, die in einer Zeit entworfen wurde, als XML Standard war – etwa mit SOAP und dem koreanischen E-Government-Standard-Framework (전자정부 표준프레임워크) ② XML-Attribute werden in JSON als Schlüssel mit dem Präfix „@" dargestellt, Text neben Tags als Schlüssel „#text" – jeweils getrennt ③ Ein Element mit einem bestimmten Namen wird zum Objekt, wenn es nur einmal vorkommt, und zum Array, wenn es mehrfach vorkommt. Von außen sieht man daher nicht auf Anhieb, wie viele Werte vorhanden sind

Warum antworten manche APIs noch immer mit XML?

Es gab eine Zeit, in der XML der De-facto-Standard für Web-APIs war. In den frühen bis mittleren 2000er-Jahren waren SOAP-basierte Webservices die übliche Kommunikationsform in Unternehmens- und Behördensystemen. Systeme, die damals entworfen wurden, behalten diese Struktur bis heute bei.

Ein großer Teil der koreanischen Behördensysteme basiert auf dem E-Government-Standard-Framework. Dieser Standard etablierte sich, als XML und SOAP vorherrschten. Auch nachdem JSON sich durchgesetzt hatte, wurden bestehende Systeme meist nicht umgebaut, sondern mit ihrer XML-Antwortstruktur weiterbetrieben.

Bei den offenen APIs, die Sie über das koreanische Open-Data-Portal (공공데이터포털) beziehen können, ist es ähnlich. Es gibt weiterhin APIs, die XML als Standard ausliefern, wenn der Anfrageparameter kein Antwortformat angibt. JSON erhalten Sie dort oft nur, wenn Sie einen zusätzlichen Parameter setzen.

Solange ein System nicht komplett neu konzipiert wird, lässt sich allein das Antwortformat kaum ändern. Praktikabel ist deshalb meist, das XML auf der Anfrageseite zu empfangen und selbst in JSON umzuwandeln.

XML in JSON umwandeln: zuerst Attribute und wiederholte Tags klären

Für die Umwandlung von XML in JSON gelten feste Regeln. Als Beispiel dient ein XML-Dokument mit Buchinformationen: Ganz oben steht ein Element book mit dem Attribut id=1. Darin befinden sich je ein Element title und price sowie zwei Elemente tags.

Drei Regeln für die Umwandlung von XML in JSON

Regel 1 – Elementnamen werden unverändert zu Schlüsseln. Bei Elementen ohne Kindelemente wie title und price wird der Name zum Schlüssel und der enthaltene Text zum Wert.

Regel 2 – Attribute werden nicht mit dem eigentlichen Wert vermischt, sondern als eigener Schlüssel mit dem Präfix „@" abgelegt. Das Attribut id von book landet im Schlüssel @id. Hat ein Element zusätzlich Text, steht dieser separat im Schlüssel #text.

Regel 3 – Kommt ein Element mit demselben Namen mehrfach als Geschwisterelement vor, wird daraus ein Array. Da tags zweimal vorkommt, ist der Wert ein Array mit SEO und Blog. Wäre das Element nur einmal vorhanden, würde daraus kein Array, sondern ein einzelner String.

Wenden Sie die drei Regeln an, erhalten Sie ein JSON, in dem unter dem Schlüssel book Folgendes steht: @id mit dem Wert „1", title mit „자동화의 정석", price mit „18000" und tags als Array mit SEO und Blog.

Von JSON zurück zu XML

Objekte werden als verschachtelte Kindelemente ausgegeben, Arrays als Wiederholung des gleichnamigen Elements, und zwar so oft, wie Werte vorhanden sind. Dafür wird ein Wurzelelement benötigt, das das gesamte JSON umschließt. Selbst wenn es wie bei book nur einen Schlüssel gibt, wird dieser nicht automatisch zum obersten Tag. Stattdessen wird er noch einmal vom angegebenen Wurzelelement umschlossen.

Die Regeln selbst sind nicht schwierig. Sind Elemente jedoch verschachtelt und mischen sich Attribute und wiederholte Elemente, übersieht man beim manuellen Übertragen leicht, an welcher Stelle ein Array entstehen muss. Besonders bei längeren Vorlagen ist es mühsam, per Auge zu zählen, wie oft ein Element vorkommt.

Mit unserem Tool prüfen. Wählen Sie die Umwandlungsrichtung per Tab und fügen Sie Ihre Vorlage ein. Sie sehen sofort das Ergebnis, bei dem Attribute und wiederholte Elemente regelkonform verarbeitet wurden. Das kostenlose Tool heißt „JSON ↔ XML Konverter": Es wandelt JSON und XML in beide Richtungen um (unterstützt Grundstrukturen, Attribute und wiederholte Elemente).

JSON ↔ XML Konverter

Kostenlos · ohne Anmeldung · JSON ↔ XML direkt im Browser umwandeln

Typische Stolpersteine

SituationHintergrund
Ein Element hat AttributeAttribute werden nicht mit dem Textwert vermischt, sondern als eigener Schlüssel mit dem Präfix „@" abgelegt
Dasselbe Element kommt einmal vs. mehrfach vorBei einem Vorkommen ergibt sich ein Einzelwert, ab zwei Vorkommen ein Array – der nachfolgende Verarbeitungscode muss entsprechend angepasst werden
Umwandlung von JSON in XMLDer oberste Schlüssel der Vorlage wird nicht automatisch zum Tag, sondern noch einmal vom angegebenen Wurzelelement umschlossen
Leere Objekte oder ArraysSie werden als selbstschließendes Element ohne schließenden Tag, nur mit dem Namen, dargestellt, sodass man leicht unsicher ist, ob der Wert leer ist

Alle Situationen in der Tabelle lassen sich letztlich auf zwei Fragen zurückführen: „Gibt es Attribute?" und „Wiederholt sich dasselbe Element?" Wenn Sie beim Lesen von XML zuerst diese beiden Punkte prüfen, können Sie das Ergebnis der Umwandlung leichter vorhersagen.

Fazit

Behörden und ältere Systeme antworten noch mit XML, weil sie die Struktur beibehalten, die zu einer Zeit entworfen wurde, als XML Standard war – etwa mit SOAP und dem E-Government-Standard-Framework. Solange das System selbst nicht neu entwickelt wird, ist es praktikabel, XML auf der Anfrageseite zu empfangen und in JSON umzuwandeln.

Bei den Umwandlungsregeln kommt es vor allem auf zwei Punkte an: Attribute werden in Schlüssel mit dem Präfix „@" ausgelagert, und wiederholte Elemente werden zu einem Array zusammengefasst. Mit diesen Regeln können Sie auch von Hand umwandeln, doch je mehr Elemente es werden, desto mühsamer wird es, per Auge zu zählen, ob sich etwas wiederholt.

JSON ↔ XML Konverter

Kostenlos · ohne Anmeldung · JSON ↔ XML direkt im Browser umwandeln

Häufig gestellte Fragen

Wie werden XML-Attribute in JSON dargestellt?

Attribute werden zur Unterscheidung vom eigentlichen Textwert als eigener Schlüssel in der Form „@Attributname" abgelegt. Hat ein Element sowohl Attribute als auch Text, steht der Text separat im Schlüssel „#text". So werden Attribute und Text nicht zu einem einzigen Wert vermischt.

Wird aus einem mehrfach vorkommenden Tag immer ein Array?

Kommt ein Element mit demselben Namen als Geschwisterelement zwei- oder mehrmals vor, wird daraus ein Array. Kommt es nur einmal vor, wird es nicht als Array, sondern als Einzelwert (String oder Objekt) behandelt. Im Code sollten Sie deshalb zuerst prüfen, ob es sich um ein Array handelt oder nicht.

Warum braucht man beim Umwandeln von JSON in XML einen Namen für das Wurzelelement?

Ein XML-Dokument muss mit genau einem obersten Element beginnen. Auch wenn das ursprüngliche JSON nur einen einzigen Schlüssel enthält, wird dieser nicht automatisch zum obersten Tag. Stattdessen bildet das angegebene Wurzelelement den äußeren Tag, und der ursprüngliche Schlüssel steht darin als Kindelement.

Dieser Artikel basiert auf unserem koreanischen Original. Koreanisches Original lesen

Ähnliche Artikel

  1. CSV in Kalender importieren: Warum Zeilen fehlenSo wird eine CSV-Terminliste zu einer .ics-Datei mit mehreren Ereignissen – und warum Zeilen ohne Titel, Start oder passendes Datum still wegfallen.
  2. CSV-Upload fehlgeschlagen: Spaltenreihenfolge und Header prüfenWarum Werte verrutschen oder ein CSV-Import abgelehnt wird: So gleichen Programme Spalten nach Reihenfolge oder Header-Namen ab – inklusive unsichtbarer Leerzeichen.
  3. CSV Spalten umsortieren: Zeilen mit abweichender SpaltenzahlWas passiert beim Umsortieren von CSV-Spalten, wenn Zeilen mehr oder weniger Spalten als die Kopfzeile haben, und wie Sie die Spaltenzahl vorher prüfen.
  4. CSV Duplikate entfernen: ganze Zeile oder bestimmte Spalte?Ob eine ganze Zeile oder nur eine Spalte wie die E-Mail-Adresse über Duplikate entscheidet, ändert das Ergebnis. Zwei typische Fehler, mit Beispielen erklärt.
  5. CSV in Excel öffnen: Nullen und Zahlenformat bleiben erhaltenWarum Excel beim Öffnen von CSV führende Nullen entfernt und lange Zahlen als E+12 anzeigt – und wie Sie die Formate festlegen und als .xlsx speichern.
  6. CSV landet in Excel in einer Zelle: Trennzeichen richtig wählenWarum Excel eine CSV-Datei komplett in Spalte A zeigt: Das liegt am Listentrennzeichen. So erstellen Sie die Datei vorab mit Semikolon als Trennzeichen.

Passende Tools