Seite 12 - REST-API

Handgeschriebene TypeScript-Interfaces für REST-Endpunkte veralten schleichend, sobald sich das Backend weiterentwickelt, und liefern dann trügerische Typsicherheit statt echtem Schutz vor Laufzeitfehlern. Dieser Artikel zeigt, wie openapi-typescript und verwandte Tools TypeScript-Typen sowie typisierte Fetch-Clients direkt aus einer OpenAPI-Spezifikation erzeugen und wie sich dieser Prozess zuverlässig in Build- und CI-Pipelines verankern lässt.

API Platform generiert OpenAPI-Dokumentation aus PHP-Klassen – das spart Stunden manueller Arbeit. Aber Schema-Namen mit internen Zählern, fehlende Beispiele, rudimentäre Security-Definitionen und nicht dokumentierte Fehlerfälle zeigen, wo das Automatismus-Versprechen seine Grenzen hat. Dieser Artikel zeigt konkret, was gut funktioniert – und was überschrieben werden muss.

Exportierte CSV-Dateien aus ERP-Systemen, Warenwirtschaften oder alten Datenbanken müssen fast immer als JSON in moderne APIs importiert werden. Eine CSV zu JSON Pipeline aus mlr, jq und Bash-Glue-Code erledigt Typkonvertierung, Verschachtelung und Validierung ohne eine einzige Zeile Python.

Eine REST-API, die bei jedem Request dieselben Daten aus der Datenbank lädt und vollständig zurücksendet, verschwendet Bandbreite und Serverressourcen. ETag, Last-Modified und Cache-Control sind die HTTP-Standard-Werkzeuge, die genau das verhindern – mit 304 Not Modified für unveränderte Ressourcen und Proxy-Caching für öffentliche Daten.

Eine REST-API, die niemals Breaking Changes durchführt, ist eine API, die niemals wirklich weiterentwickelt wird. Wer Deprecations, Sunset-Dates und Migrationspfade von Anfang an einplant, kann APIs gezielt weiterentwickeln, ohne Integratoren zu verlieren oder ohne Vorwarnung zu brechen.

Eine ERP-Integration entscheidet oft darüber, ob Magento zuverlässig aktuelle Preise, Bestände und Aufträge zeigt oder ob Support und Buchhaltung ständig Abweichungen korrigieren müssen. Die richtige Architektur mit Datenmapping, Message Queue und klarer Konfliktauflösung macht den Unterschied zwischen einer fragilen Punkt zu Punkt Kopplung und einer belastbaren ERP Integration.

Eine OpenAPI-Spezifikation, die nur für die Dokumentation existiert, bringt wenig. Wer sie als bindenden Vertrag zwischen Frontend, Backend und externen Konsumenten behandelt – und sie mit Contract-Tests, RFC-7807-Fehlerformaten, Security-Schemas und automatisiertem Tooling absichert – macht aus einer YAML-Datei ein produktives Qualitätswerkzeug.

Eine öffentliche API ohne Rate Limiting ist eine offene Einladung für Abuse. Token-Bucket- und Sliding-Window-Algorithmen begrenzen die Anfragelast pro Client, API-Keys ermöglichen differenzierte Limits und Abuse-Prevention-Patterns erkennen und blockieren missbräuchliches Verhalten – bevor es die Infrastruktur trifft.

HATEOAS macht eine PHP-API zur echten Zustandsmaschine: statt dass Clients URLs selbst zusammenbauen, liefert jede Antwort die Links mit, die im aktuellen Zustand tatsächlich erlaubt sind. Dieser Artikel zeigt eine praktische HATEOAS-Umsetzung in PHP mit HAL-Format, einem eigenen Link-Builder und konkreten Beispielen aus einem Bestellprozess.

Viele Magento und PHP APIs antworten in 400 bis 800 Millisekunden, obwohl die eigentliche Arbeit in wenigen Millisekunden erledigt werden könnte. Dieser Artikel zeigt anhand einer konkreten Fallstudie, wie sich Antwortzeiten durch systematisches Profiling, Datenbankindizes, Caching, cursorbasierte Pagination und asynchrone Verarbeitung von 500 Millisekunden auf unter 50 Millisekunden senken lassen.