Die JSON-Antwort einer API validieren

In der Praxis ist eine HTTP-Antwort nicht automatisch gültiges JSON, nur weil die Schnittstelle es verspricht. Häufig liefert ein Server im Fehlerfall statt der erwarteten Nutzlast eine HTML-Seite mit einer Statusmeldung, etwa bei einem Gateway-Fehler oder einer Weiterleitung zum Login. Ein solcher Text beginnt oft mit spitzen Klammern und lässt jeden JSON-Parser sofort scheitern. Ebenso kommt es vor, dass eine Antwort abgeschnitten ankommt, weil die Verbindung abbrach oder ein Proxy die Nutzlast kürzte. Dann fehlt am Ende die schließende Klammer, und das JSON ist unvollständig. Auch ein falsch gesetzter Content-Type oder ein vorangestelltes Steuerzeichen kann die Verarbeitung stören. Wenn Sie die Antwort vor dem Parsen prüfen, erkennen Sie diese Fälle sofort, statt sie erst durch einen Absturz in Ihrem Code zu bemerken.

Der größte Vorteil einer vorgeschalteten Prüfung ist, dass Sie die Fehlerquelle sauber trennen. Wenn Ihre Anwendung beim Parsen einer Antwort einen Fehler wirft, ist zunächst unklar, ob Ihr Code falsch liegt oder ob die Schnittstelle fehlerhafte Daten geschickt hat. Indem Sie den rohen Response Body in dieses Werkzeug einfügen, beantworten Sie diese Frage in Sekunden. Meldet das Werkzeug gültiges JSON, liegt der Fehler in Ihrer Verarbeitung, etwa bei einem falschen Feldzugriff. Meldet es einen Syntaxfehler mit Position, wissen Sie, dass bereits die Antwort selbst nicht wohlgeformt ist, und können den Fehler beim API-Anbieter melden. Diese Klarheit spart erhebliche Zeit im Debugging, gerade wenn mehrere Systeme beteiligt sind und die Antwort durch Gateways, Caches oder Middleware gelaufen ist, bevor sie Ihren Client erreicht.

Damit ein Parser eine Antwort akzeptiert, muss sie den Grammatikregeln von JSON exakt folgen. Alle Schlüssel und alle Zeichenketten stehen in doppelten Anführungszeichen, einfache Anführungszeichen sind ungültig. Zwischen den Elementen eines Objekts oder Arrays steht genau ein Komma, nach dem letzten Element jedoch keines. Kommentare sind nicht erlaubt, obwohl manche Backends sie versehentlich mitsenden. Zahlen dürfen keine führenden Nullen oder ein nachgestelltes Plus haben, und Sonderzeichen in Zeichenketten müssen korrekt maskiert sein. Ein häufiger Stolperstein sind nicht escapte Zeilenumbrüche in Textfeldern, die aus einer Datenbank stammen. Das Werkzeug prüft all diese Regeln und meldet die erste Verletzung mit ihrer Position. So sehen Sie nicht nur, dass die Antwort ungültig ist, sondern auch, welches konkrete Zeichen die Grammatik bricht und wo Sie beim API-Team nachhaken sollten.

API-Antworten enthalten oft sensible Inhalte: Zugriffstoken, Sitzungsschlüssel, personenbezogene Daten von Kundinnen und Kunden oder interne Kennungen. Deshalb ist es wichtig, dass dieses Werkzeug die Antwort ausschließlich lokal in Ihrem Browser prüft. Der eingefügte Text wird nicht hochgeladen, nicht zwischengespeichert und nicht an Dritte weitergegeben. Die gesamte Analyse läuft als JavaScript in der geladenen Seite, sodass die Daten Ihr Gerät nie verlassen. Sie können also auch eine Produktionsantwort mit echten Nutzerdaten gefahrlos prüfen, ohne gegen Datenschutzvorgaben zu verstoßen. Ein weiterer Vorteil dieser Bauweise ist die Geschwindigkeit: Weil kein Netzwerkweg zu einem Server nötig ist, erhalten Sie das Ergebnis unmittelbar. Sobald die Seite geladen ist, funktioniert die Prüfung sogar offline. Es gibt keine Anmeldung, kein Wasserzeichen und keine künstliche Begrenzung der Antwortgröße außer dem Speicher Ihres Browsers.

Eine wohlgeformte Antwort ist die Grundvoraussetzung, aber nicht immer ausreichend. Ihr Code erwartet meist eine bestimmte Struktur, etwa ein Feld mit einer Zahl oder ein Array von Objekten mit festen Schlüsseln. Ob die Antwort diese Erwartung erfüllt, prüft die Schemavalidierung. Dieses Werkzeug kann optional gegen ein JSON Schema testen, sodass Sie nicht nur die Syntax, sondern auch den Aufbau der Antwort absichern. Technisch entspricht die Grundprüfung genau dem, was Ihre Anwendung beim Aufruf von JSON.parse tut. Scheitert der Parser hier, scheitert er auch in Ihrem Code, nur dass Sie die Ursache im Werkzeug übersichtlich aufbereitet sehen. So können Sie Verträge zwischen Frontend und Backend zuverlässiger einhalten und Abweichungen früh erkennen, bevor sie im Produktivbetrieb zu schwer auffindbaren Fehlern führen. Die Kombination aus Syntax- und Schemaprüfung macht die Integration robuster.