Wie schwer kann es also sein, eine API zu versionieren? Die Wahrheit ist, dass es nicht schwer ist, aber was schwer ist, ist die Aufrechterhaltung einer gewissen Vernunft, indem man sich nicht unnötig in eine verwirrende Anzahl von Versionen und Unterversionen verwickelt, die auf Dutzende von API-Endpunkten angewendet werden, mit unklaren Kompatibilitäten.
Breaking Changes Schlecht! API Versioning Gut!
Wie jeder, der eine API aufgebaut hat oder regelmäßig nutzt, früher oder später erkennt, sind Breaking Changes sehr schlecht und können ein sehr ernsthaftes Manko an einer ansonsten nützlichen API sein. Ein Breaking Change ist eine Änderung am Verhalten einer API, die die Integration eines Benutzers brechen und zu viel Frustration und Vertrauensverlust zwischen dem API-Anbieter und dem Benutzer führen kann. Breaking Changes erfordern, dass Benutzer im Voraus benachrichtigt werden (mit begleitendem Mea Culpa), anstatt dass eine Änderung einfach auftaucht, wie zum Beispiel ein freudiges neues Feature. Der Weg, um diese Frustration zu vermeiden, ist, eine API mit der Zusicherung des API-Eigentümers zu versionieren, dass innerhalb einer einzigen Version keine überraschenden Änderungen eingeführt werden.
Also, wie schwer kann es sein, eine API zu versionieren? Die Wahrheit ist, dass es das nicht ist, aber was schwierig ist, ist, etwas Verstand zu bewahren, indem man nicht unnötig in eine schwindelerregende Anzahl von Versionen und Subversionen verfällt, die über Dutzende von API-Endpunkten mit unklaren Kompatibilitäten angewendet werden.
Wir haben v1 der API vor drei Jahren eingeführt und haben nicht erkannt, dass sie bis heute stark genutzt wird. Also, wie haben wir es geschafft, die beste E-Mail-Zustellungs-API seit über zwei Jahren bereitzustellen, aber dennoch dieselbe API-Version beizubehalten? Diese Stabilität ist entscheidend für Entwickler, die Anwendungen mit E-Mail-APIs in Cloud-Infrastruktur erstellen, wo Zuverlässigkeit und Konsistenz von größter Bedeutung sind. Während es viele verschiedene Meinungen darüber gibt, wie man REST-APIs versioniert, hoffe ich, dass die Geschichte unseres bescheidenen, aber leistungsstarken v1 Sie auf Ihrem Weg zur API-Versionierungserleuchtung leiten kann.
REST Ist Best
API Governance
Mit einer ausgewählten Versionskonvention hatten wir weitere Fragen. Wann würden wir die Version erhöhen? Was ist eine breaking change? Würden wir die gesamte API oder nur bestimmte Endpunkte neu versionieren? Bei SparkPost arbeiten mehrere Teams an verschiedenen Teilen unserer API. Innerhalb dieser Teams arbeiten Leute zu unterschiedlichen Zeiten an verschiedenen Endpunkten. Daher ist es sehr wichtig, dass unsere API in der Nutzung von Konventionen konsistent ist. Das war größer als die Versionierung.
Wir haben eine Governance-Gruppe gegründet, die Ingenieure aus jedem Team, ein Mitglied des Product Management Teams und unseren CTO umfasst. Diese Gruppe ist verantwortlich für die Etablierung, Dokumentation und Durchsetzung unserer API-Konventionen über alle Teams hinweg. Ein API-Governance-Slack-Kanal ist auch nützlich für lebhafte Diskussionen zu diesem Thema.
Die Governance-Gruppe identifizierte eine Reihe von Möglichkeiten, wie Änderungen an der API eingeführt werden können, die dem Benutzer zugute kommen und keine breaking change darstellen. Dazu gehören:
Eine neue Ressource oder API-Endpunkt
Ein neuer optionaler Parameter
Eine Änderung an einem nicht öffentlichen API-Endpunkt
Ein neuer optionaler Schlüssel im JSON-POST-Body
Ein neuer Schlüssel, der im JSON-Antwortkörper zurückgegeben wird
Umgekehrt beinhaltete eine breaking change alles, was die Integration eines Benutzers beeinträchtigen könnte, wie zum Beispiel:
Ein neuer erforderlicher Parameter
Ein neuer erforderlicher Schlüssel in POST-Bodies
Entfernung eines bestehenden Endpunkts
Entfernung einer bestehenden Endpunktanforderungsmethode
Ein materiell unterschiedliches internes Verhalten eines API-Aufrufs – wie etwa eine Änderung des Standardverhaltens.
The Big 1.0
Während wir diese Konventionen dokumentierten und diskutierten, kamen wir auch zu dem Schluss, dass es im Interesse aller ist (einschließlich unseres!), Änderungen an der API zu vermeiden, da die Verwaltung mehrerer Versionen mit erheblichem Aufwand verbunden ist. Wir entschieden, dass es einige Dinge gibt, die wir mit unserer API beheben sollten, bevor wir uns auf „v1“ festlegen.
Das Senden einer einfachen E-Mail erforderte viel zu viel Aufwand. Um „die einfachen Dinge einfach zu halten“, aktualisierten wir den POST-Body, um sicherzustellen, dass sowohl einfache als auch komplexe Anwendungsfälle berücksichtigt werden. Das neue Format war auch zukunftssicherer. Zweitens haben wir ein Problem mit dem Metrics-Endpunkt angesprochen. Dieser Endpunkt verwendete einen „group_by“-Parameter, der das Format des GET-Antwort-Body so änderte, dass der erste Schlüssel der Wert des group by Parameters war. Das schien nicht sehr RESTful, daher haben wir jedes group by in einen eigenen Endpunkt aufgeteilt. Schließlich haben wir jeden Endpunkt geprüft und hier und da kleinere Änderungen vorgenommen, um sicherzustellen, dass sie den Standards entsprachen.
Accurate Dokumentation
Es ist wichtig, genaue und nutzbare API-Dokumentation zu haben, um breaking changes, absichtlich oder unabsichtlich, zu vermeiden. Wir haben uns entschieden, einen einfachen API-Dokumentationsansatz zu verwenden und eine Markdown-Sprache namens API Blueprint zu nutzen und unsere Dokumente in Github zu verwalten. Unsere Community trägt zu diesen Open-Source-Dokumenten bei und verbessert sie. Wir pflegen auch einen nicht öffentlichen Satz von Dokumenten in Github für interne APIs und Endpunkte.
Ursprünglich haben wir unsere Dokumente auf Apiary veröffentlicht, ein großartiges Werkzeug zum Prototypisieren und Veröffentlichen von API-Dokumenten. Allerdings funktioniert das Einbetten von Apiary auf unserer Website nicht auf mobilen Geräten, daher verwenden wir jetzt Jekyll, um statische Dokumente zu generieren. Unsere neuesten SparkPost API docs laden jetzt schnell und funktionieren gut auf mobilen Geräten, was wichtig ist für Entwickler, die nicht immer an ihrem Computer sitzen.
Trennung von Deployment und Release
Wir haben schon früh den wertvollen Trick gelernt, die Bereitstellung von einem Release zu trennen. Auf diese Weise ist es möglich, Änderungen häufig bereitzustellen, wenn sie durch kontinuierliche Lieferung und Bereitstellung bereit sind, aber wir kündigen sie nicht immer öffentlich an oder dokumentieren sie gleichzeitig. Es ist nicht ungewöhnlich für uns, einen neuen API-Endpunkt oder eine Verbesserung eines vorhandenen API-Endpunkts bereitzustellen und ihn innerhalb der Benutzeroberfläche oder mit internen Werkzeugen zu nutzen, bevor wir es öffentlich dokumentieren und unterstützen. So können wir einige Anpassungen für die Benutzerfreundlichkeit oder die Einhaltung von Standards vornehmen, ohne uns Sorgen über gefürchtete breaking changes machen zu müssen. Sobald wir mit der Änderung zufrieden sind, fügen wir sie unserer öffentlichen Dokumentation hinzu.
Mist!
Es ist nur fair zuzugeben, dass es Zeiten gab, in denen wir unseren Idealen „keine Änderungen, die zu Problemen führen“ nicht gerecht geworden sind, und daraus sollte man lernen. Bei einer Gelegenheit entschieden wir, dass es für die Benutzer besser wäre, wenn eine bestimmte Eigenschaft standardmäßig auf „true“ anstatt auf „false“ eingestellt wäre. Nachdem wir die Änderung implementiert hatten, erhielten wir mehrere Beschwerden von Benutzern, da sich das Verhalten unerwartet geändert hatte. Wir machten die Änderung rückgängig und fügten eine Kontoeinstellung hinzu – ein viel benutzerfreundlicherer Ansatz, ganz sicher.
Gelegentlich sind wir versucht, aufgrund von Fehlerbehebungen Änderungen, die zu Problemen führen könnten, einzuführen. Allerdings entschieden wir, diese Eigenheiten in Ruhe zu lassen, anstatt das Risiko einzugehen, die Integrationen der Kunden um der Konsistenz willen zu stören.
Es gibt seltene Fälle, in denen wir die ernsthafte Entscheidung trafen, eine Änderung, die zu Problemen führen könnte, vorzunehmen – wie das Veralten einer API-Ressource oder Methode – im Interesse der Benutzer-Community insgesamt und nur nach Bestätigung, dass es nur geringe oder keine Auswirkungen auf die Benutzer gibt. Beispielsweise trafen wir bewusst die Entscheidung, das Antwortverhalten der Suppression API zu ändern, jedoch erst nach sorgfältiger Abwägung der Vorteile und Auswirkungen auf die Community und sorgfältiger Kommunikation der Änderung an unsere Benutzer. Wir würden jedoch niemals eine Änderung einführen, die auch nur eine entfernte Möglichkeit hat, das Senden einer Produktions-E-Mail eines Benutzers direkt zu beeinträchtigen.
