Entwerfen von Web APIs

Kapitel 7. Den Wandel managen

Diese Arbeit wurde mithilfe von KI übersetzt. Wir freuen uns über dein Feedback und deine Kommentare: [e-mail]

Gutes Design ist nie in der Zeit eingefroren. Nur weil du heute ein tolles Design gemacht hast, heißt das nicht, dass es auch dann noch gut ist, wenn sich etwas ändert. Gute APIs müssen in der Lage sein, sich anzupassen und sich mit der Entwicklung deines Produkts oder Unternehmens zu verändern.

Änderungen sind eine der häufigsten Fallstricke vieler APIs. In diesem Kapitel besprechen wir, wie du Änderungen mit einem Auge für Konsistenz angehst und wie du die Abwärtskompatibilität sicherstellst, wenn sich deine API weiterentwickelt.

Expertenrat

Eine API sollte konsistent, klar und gut dokumentiert sein. Kleine Unstimmigkeiten bei Dingen wie der Namensgebung und den URLs führen zu einer Menge Verwirrung, wenn deine API altert. Um Änderungen zu vermeiden, solltest du dein Bestes tun, um konsistent zu bleiben, aber vor allem, um sicherzustellen, dass neue Ergänzungen für Integratoren klar und deutlich sind.

Kyle Daigle, Director of Ecosystem Engineering bei GitHub

Auf dem Weg zur Konsistenz

Konsistenz ist das Markenzeichen von exzellenten Erfahrungen, egal welcher Art - APIs sind da keine Ausnahme. Konsistenz schafft Vertrauen. Vertrauen ist die Grundlage für ein florierendes Entwickler-Ökosystem.

Hier sind einige der Kennzeichen der Konsistenz:

• Die Entwickler können ein mentales Modell erstellen, wie sie auf die ...