Zum Inhalt springen

Den API‑Vertrag aus der Datenbank generiert

Den API‑Vertrag von der Datenbank aus nach außen generiert — OpenAPI, einen typisierten TypeScript‑Client mit 44.076 Zeilen, 61 Mock‑Handler und die von der UI durchgesetzten Grenzen — mit einer Prüfung an jedem Übergang, die Abweichungen zurückweist.

44,076 aus der Datenbank erzeugte Zeilen eines typisierten Clients

Situation. Frontend und Backend entwickeln sich in ihrem eigenen Tempo; ihre Annahmen über Anfragedaten können unbemerkt auseinanderlaufen. Meist zeigt sich das erst als 422 im Browser, nachdem die Unstimmigkeit bereits veröffentlicht wurde — also zum teuersten Zeitpunkt. Beide Seiten von Hand nach demselben Dokument zu schreiben löst das Problem nicht, sondern verlagert es auf die Person, die das erneute Lesen vergessen hat.

Aufgabe. Beide Seiten sollten aus einer Quelle erzeugt werden, statt zwischen zwei Quellen abgestimmt zu sein. Jeder Erzeugungsschritt musste geprüft werden, statt ihm einfach zu vertrauen.

Massnahmen. Die Kette beginnt in der Datenbank und führt nach außen. Schema und Funktionen legen die Strukturen fest, Go‑Typen definieren die API, Huma erzeugt daraus OpenAPI, und daraus wird ein typisierter TypeScript‑Client mit 44.076 Zeilen generiert. Parallel entstehen 61 Mock‑Handler, damit Frontendtests gegen den echten Vertrag laufen statt gegen handgeschriebene Testdaten. Auch die Formulargrenzen der UI stammen aus derselben Quelle, statt erneut in einen Validator eingetippt zu werden. Jeder Übergang ist abgesichert. Eine CI‑Vertragsprüfung vergleicht Frontendanfragen mit den Erwartungen der API und lässt den Build bei Abweichungen scheitern. Darunter prüft eine Schemasonde die tatsächlichen Strukturen statt ihrer Beschreibung. Bewusst erfasst werden typische Verstecke für Abweichungen: optionale Body‑Felder, bei denen “fehlend” und “null” verwechselt werden, sowie Enums in Abfrageparametern mit möglicherweise unterschiedlichen erlaubten Werten.

Ergebnis. Ein Feld kann sich nicht nur auf einer Seite ändern: Der erste bemerkende Übergang lässt den Build wenige Minuten nach der Änderung scheitern. Damit entfiel eine wiederkehrende, lästige Fehlerklasse, die im Code‑Review unsichtbar blieb und erst zur Laufzeit auffiel. Der Preis ist ein Generierungsschritt mitten im Arbeitsablauf. Neuerzeugung kostet Aufwand, und die Kette ist nur so vertrauenswürdig wie ihr am wenigsten abgesichertes Glied — weshalb jeder Übergang eine eigene Prüfung erhielt.

  • Loses Puzzleteil neben einer Lücke
    Foto: 422737 / Pixabay
  • Bunte Puzzleteile
    Foto: rkit / Pixabay

Diese Erfahrung für Ihr Projekt nutzen

Nutzen Sie „Den API‑Vertrag aus der Datenbank generiert“ als Ausgangspunkt für eine ähnliche Herausforderung in Ihrer Organisation. Die Leistungen hinter dieser Arbeit stehen auch für Ihr Projekt zur Verfügung. Geprüft, veröffentlicht und rückgängig zu machen: Änderungen erreichen Ihre Kunden am Dienstagnachmittag statt spät am Freitagabend.

Unsere Leistungen entdecken Kontakt aufnehmen

Hinter das Ergebnis schauen

Lesen Sie die Situation, die Entscheidungen und das Ergebnis dieses Beispiels. Wir können besprechen, welche Teile sich auf Ihre Rahmenbedingungen übertragen lassen und welche einen anderen Ansatz erfordern. Den API‑Vertrag aus der Datenbank generiert — 44,076 aus der Datenbank erzeugte Zeilen eines typisierten Clients

Unsere Leistungen entdecken Kontakt aufnehmen

Ein Teil einer längeren Arbeitsbilanz — vollständig auf dieser Website zu finden.

Jeder Eintrag folgt demselben Aufbau: die Situation, die Aufgabe, unser Vorgehen und die Veränderungen.

Alle Arbeiten ansehen

Die benötigte Verbesserung definieren

Beschreiben Sie den Bereitstellungsweg, die Betriebsrisiken und die Bereitschaftsverantwortlichen. Wir können eine Änderung mit Prüfungen, einem Wiederherstellungsweg und klaren Zuständigkeiten abgrenzen.

Preise ansehen Kontakt aufnehmen

Entwickeln sich Frontend und Backend auseinander?

Fragen Sie nach den Entscheidungen hinter „Den API‑Vertrag aus der Datenbank generiert“. Sie sprechen mit den Menschen, die die Arbeit erklären und Ihr eigenes Projekt einschätzen können.

Unsere Leistungen entdecken
welcome@engineer.company +45 50 10 61 84 Kopenhagen, Dänemark
QR-Code für Den API‑Vertrag von der Datenbank aus nach außen generiert — OpenAPI, einen typisierten TypeScript‑Client mit 44.076 Zeilen, 61 Mock‑Handler und die von der UI durchgesetzten Grenzen — mit einer Prüfung an jedem Übergang, die Abweichungen zurückweist.
Nehmen Sie diese Seite mithttps://platform.engineer.company/de/portfolio/generated-the-api-contract-from-the-database-out/